RequisitionItems
Get the list of Requisition Items
Path
GET /odata/RequisitionItems
Description
Returns the paged list of existing Requisition Items. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).
Request parameters
Parameter |
Explanation |
|---|---|
| api-version: string default: 1.0 in header |
The requested API version. |
| $filter: string in query |
Filters the results, based on a Boolean condition. |
| $orderby: string in query |
Sorts the results. |
| $search: string in query |
Picks the value in all possible fields. |
| $top: string in query |
Returns only the first n results. |
| $skip: string in query |
Skips the first n results. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 400 Bad Request | The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| requisitionItemId: string (uuid) | Unique Identifier of the Requisition Item |
| requisitionId: string (uuid) | Unique Identifier of the Requisition |
| requisitionNo: string | Identification code of the Requisition |
| lineItemNo: integer (int32) | Number of the Line Item |
| inventoryNo: string | Identification code of the Inventory Item |
| inventoryDescription: string | Description of the Inventory Item |
| vendorItemNo: string | Code that is used by the Vendor for the Item identification |
| lineItemTypeId: integer (int32) | Unique Identifier of the Line Item Type |
| lineItemType: string | Type of the Line Item |
| quantity: integer (int32) | Quantity specified in the Line Items |
| UOM: string | Unit of Measure |
| conversionFactor: integer (int32) |
Number of Stock Keeping Units in another Unit of Measure |
| price: number (double) | Price of the Line Item |
| inventoryLocationId: string (uuid) |
Unique Identifier of the Inventory Location |
| notes: string | Comments about the Requisition Item |
| manufacturerId: string (uuid) | Unique Identifier of the Manufacturer |
| manufacturerItemNo: string | Item Number of the Manufacturer |
| suggestedVendorId: string (uuid) |
Suggested Unique Identifier of the Vendor |
| stockUOM: string | Unit of Measure to track Inventory Balance |
| vendorId: string (uuid) | Unique Identifier of the Vendor |
| poConversionStatusId: integer (int32) |
Unique Identifier of Purchase Order Conversion Status |
| poConversionStatus: string | Conversion Status of Purchase Order |
| purchaseOrderItemId: string (uuid) |
Unique Identifier of the Purchase Order Item |
| inventoryVendorId: string (uuid) | Unique Identifier of the Inventory Item Vendor |
| activeStatus: boolean | Is the Requisition Item active or not? |
| dateCreated: string (date-time) | Date when the Requisition Item was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the Requisition Item |
| createdByUserName: string | Name of the user who created the Requisition Item |
| lastUpdated: string (date-time) | Last Date when the Requisition Item was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Requisition Item |
| lastUpdatedByUserName: string |
Name of the last user who updated the Requisition Item |
| locationId: string (uuid) | Unique Identifier of the Location |
| isTaxable: boolean | Is the Location Taxable or not? |
| contractNo: string | Number of the Contract |
| contractExpDate: string (date-time) |
Expiration Date of the Contract |
| isPrinted: boolean | Is the Pick Ticket printed or not? |
| supplierPartAuxiliaryId: string | Unique Identifier of the Supplier Part Auxiliary |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"requisitionItemId": "00000000-0000-0000-0000-000000000000",
"requisitionId": "00000000-0000-0000-0000-000000000000",
"requisitionNo": "string",
"lineItemNo": "integer (int32)",
"inventoryNo": "string",
"inventoryDescription": "string",
"vendorItemNo": "string",
"lineItemTypeId": "integer (int32)",
"lineItemType": "string",
"quantity": "integer (int32)",
"uom": "string",
"conversionFactor": "integer (int32)",
"price": "number (double)",
"inventoryLocationId": "00000000-0000-0000-0000-000000000000",
"notes": "string",
"manufacturerId": "00000000-0000-0000-0000-000000000000",
"manufacturerItemNo": "string",
"suggestedVendorId": "00000000-0000-0000-0000-000000000000",
"stockUOM": "string",
"vendorId": "00000000-0000-0000-0000-000000000000",
"poConversionStatusId": "integer (int32)",
"poConversionStatus": "string",
"purchaseOrderItemId": "00000000-0000-0000-0000-000000000000",
"inventoryVendorId": "00000000-0000-0000-0000-000000000000",
"activeStatus": "boolean",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByUserName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByUserName": "string",
"locationId": "00000000-0000-0000-0000-000000000000",
"isTaxable": "boolean",
"contractNo": "string",
"contractExpDate": "string (date-time)",
"isPrinted": "boolean",
"supplierPartAuxiliaryId": "string"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Get the specified Requisition Item
Path
GET /odata/RequisitionItems({requisitionItemId})
Description
Returns the details of the Requisition Item specified by ID.
Request parameters
Parameter |
Explanation |
|---|---|
| requisitionItemId: string (uuid) required in path |
Enter the ID of the Requisition Item here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 404 Not Found | Specified ID is absent in the system. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| requisitionItemId: string (uuid) | Unique Identifier of the Requisition Item |
| requisitionId: string (uuid) | Unique Identifier of the Requisition |
| requisitionNo: string | Identification code of the Requisition |
| lineItemNo: integer (int32) | Number of the Line Item |
| inventoryNo: string | Identification code of the Inventory Item |
| inventoryDescription: string | Description of the Inventory Item |
| vendorItemNo: string | Code that is used by the Vendor for the Item identification |
| lineItemTypeId: integer (int32) | Unique Identifier of the Line Item Type |
| lineItemType: string | Type of the Line Item |
| quantity: integer (int32) | Quantity specified in the Line Items |
| UOM: string | Unit of Measure |
| conversionFactor: integer (int32) |
Number of Stock Keeping Units in another Unit of Measure |
| price: number (double) | Price of the Line Item |
| inventoryLocationId: string (uuid) |
Unique Identifier of the Inventory Location |
| notes: string | Comments about the Requisition Item |
| manufacturerId: string (uuid) | Unique Identifier of the Manufacturer |
| manufacturerItemNo: string | Item Number of the Manufacturer |
| suggestedVendorId: string (uuid) |
Suggested Unique Identifier of the Vendor |
| stockUOM: string | Unit of Measure to track Inventory Balance |
| vendorId: string (uuid) | Unique Identifier of the Vendor |
| poConversionStatusId: integer (int32) |
Unique Identifier of Purchase Order Conversion Status |
| poConversionStatus: string | Conversion Status of Purchase Order |
| purchaseOrderItemId: string (uuid) |
Unique Identifier of the Purchase Order Item |
| inventoryVendorId: string (uuid) | Unique Identifier of the Inventory Item Vendor |
| activeStatus: boolean | Is the Requisition Item active or not? |
| dateCreated: string (date-time) | Date when the Requisition Item was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the Requisition Item |
| createdByUserName: string | Name of the user who created the Requisition Item |
| lastUpdated: string (date-time) | Last Date when the Requisition Item was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Requisition Item |
| lastUpdatedByUserName: string |
Name of the last user who updated the Requisition Item |
| locationId: string (uuid) | Unique Identifier of the Location |
| isTaxable: boolean | Is the Location Taxable or not? |
| contractNo: string | Number of the Contract |
| contractExpDate: string (date-time) |
Expiration Date of the Contract |
| isPrinted: boolean | Is the Pick Ticket printed or not? |
| supplierPartAuxiliaryId: string | Unique Identifier of the Supplier Part Auxiliary |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"requisitionItemId": "00000000-0000-0000-0000-000000000000",
"requisitionId": "00000000-0000-0000-0000-000000000000",
"requisitionNo": "string",
"lineItemNo": "integer (int32)",
"inventoryNo": "string",
"inventoryDescription": "string",
"vendorItemNo": "string",
"lineItemTypeId": "integer (int32)",
"lineItemType": "string",
"quantity": "integer (int32)",
"uom": "string",
"conversionFactor": "integer (int32)",
"price": "number (double)",
"inventoryLocationId": "00000000-0000-0000-0000-000000000000",
"notes": "string",
"manufacturerId": "00000000-0000-0000-0000-000000000000",
"manufacturerItemNo": "string",
"suggestedVendorId": "00000000-0000-0000-0000-000000000000",
"stockUOM": "string",
"vendorId": "00000000-0000-0000-0000-000000000000",
"poConversionStatusId": "integer (int32)",
"poConversionStatus": "string",
"purchaseOrderItemId": "00000000-0000-0000-0000-000000000000",
"inventoryVendorId": "00000000-0000-0000-0000-000000000000",
"activeStatus": "boolean",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByUserName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByUserName": "string",
"locationId": "00000000-0000-0000-0000-000000000000",
"isTaxable": "boolean",
"contractNo": "string",
"contractExpDate": "string (date-time)",
"isPrinted": "boolean",
"supplierPartAuxiliaryId": "string"
}
Add the specified Requisition Line Item
Path
POST /odata/Requisitions({requisitionID})/RequisitionItems
Description
Adds a new Requisition Line Item within a logged organization and the specified Requisition (applicable only for the Standart Requisition type).
Request body
For adding item(s) to requisition(s)
Parameter |
Explanation |
|---|---|
| inventoryNo: string | Identification code of the Inventory. It is validated by Facility (Inventory Group). If not provided: Item is added as Free-Form. |
| inventoryDescription: string | Inventory Description of the Requisition Line Item. It is populated from matched Inventory if it is mapped with Inventory Vendor by vendor, vendorItemNo, uom, and facility. Optional: for Item that matches Inventory Master. Required: for Free-Form. |
| vendorItemNo: string | Code that is used by the Vendor for the Item identification. It is matched with appropriate Inventory Vendor data. |
| quantity: integer (int32) required |
Quantity specified in the Line Items |
| uom: string required |
Unit of Measure. It is matched with appropriate Inventory Vendor data. |
| conversionFactor: integer (int32) required |
Number of Stock Keeping Units in another Unit of Measure. It is populated from appropriate Inventory UOM Conversion Factor if Item is added as Inventory Item and the specified UOM value is matched with Inventory UOM. |
| price: string | Price. It is populated from matched Inventory Location if it exists. If Inventory Location doesn't exist, it is populated from matched Inventory Vendor. If it isn't matched with Inventory Vendor, then is populated from the request. If not provided for the Free-Form type: the 0 value will be set by default. |
| notes: string | Comments about Requisition Items. It is empty by default if is matched with appropriate Inventory Vendor data. It is populated from the request if is added as Free-Form. |
| manufacturerNo: string | Number of the Manufacturer. It is populated from matched Inventory Vendor. It is populated from matched Manufacturer if it is added as Free-Form. |
| manufacturerItemNo: string | Item Number of the Manufacturer. It is populated from matched Inventory Vendor. It is populated from the request if it is added as Free-Form. |
| vendorNo: string required |
Code of the Supplier who sells products |
| locationNo: string | Identification Number of the Location. It is populated from mapped Inventory Location. If Inventory Location doesn't exist, none by default for Item mapped with Inventory Vendor. For Free-Form—the Location is added in the request. If Item is added as Free-From but its Facility differs from RequisitionFacility, then locationNo is required. |
| facilityNo: string required |
Identification Number of the Facility |
| isTaxable: boolean | Is Requisiton Item Taxable or not? It is populated from Inventory Location if Item is mapped with Inventory Vendor. If Inventory Location doesn't exist, no by default for Item mapped with Inventory Vendor. For Free-Form— no by default. |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example
Request Example
{
"inventoryNo": "string",
"inventoryDescription": "string",
"vendorItemNo": "string",
"quantity": "integer (int32)",
"uom": "string",
"conversionFactor": "integer (int32)",
"price": "string",
"notes": "string",
"manufacturerNo": "string",
"manufacturerItemNo": "string",
"vendorNo": "string",
"locationNo": "string",
"facilityNo": "string",
"isTaxable": "boolean",
}
Request parameters
Parameter |
Explanation |
|---|---|
| requisitionId: string (uuid) required in path |
Enter the ID of the Requisition here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 400 Bad Request | The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
Response Example (200 OK)
"00000000-0000-0000-0000-000000000000"
Partially update the specified Requisition Item
Path
PATCH /odata/RequisitionItems({requisitionItemId})
Description
Partially updates the details of the Requisition Line Item specified by Requisition Item ID (applicable only for the Standart Requisition type).
Properties
For Inventory Item (Item with Location and Vendor):
Property |
Explanation |
|---|---|
| activeStatus: boolean | Is the Requisition Item active or not? |
| notes: string | Comments about the Requisition Item |
| quantity: integer (int8) | Quantity specified in the Line Items |
| uom: string | Unit of Measure |
| conversionFactor: integer (int8) | Number of Stock Keeping Units in another Unit of Measure |
| price: number (double) | Price of the Line Item |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request example (200 OK)
Request example (200 OK)
{
"activeStatus": "boolean",
"notes": "string",
"quantity": "integer (int8)",
"uom": "string",
"conversionFactor": "integer (int8)",
"price": "number (double)"
}
For Non-Stock Item (Item with Vendor):
Property |
Explanation |
|---|---|
| locationId: string (uuid) | Unique Identifier of the Location |
| activeStatus: boolean | Is the Requisition Item active or not? |
| notes: string | Comments about the Requisition Item |
| quantity: integer (int8) | Quantity specified in the Line Items |
| uom: string | Unit of Measure |
| conversionFactor: integer (int8) | Number of Stock Keeping Units in another Unit of Measure |
| price: number (double) | Price of the Line Item |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example (200 OK)
Request Example (200 OK)
{
"locationId": "00000000-0000-0000-0000-000000000000",
"activeStatus": "boolean",
"notes": "string",
"quantity": "integer (int8)",
"uom": "string",
"conversionFactor": "integer (int8)",
"price": "number (double)"
}
For Free-Form Item:
Property |
Explanation |
|---|---|
| inventoryNo: string | Identification code of the Inventory Item |
| inventoryDescription: string | Description of the Inventory Item |
| locationId: string (uuid) | Unique Identifier of the Location |
| vendorId: string (uuid) | Unique Identifier of the Vendor |
| vendorItemNo: string | Code that is used by the Vendor for the Item identification |
| manufacturerId: string (uuid) | Unique Identifier of the Manufacturer |
| manufacturerItemNo: string | Item Number of the Manufacturer |
| activeStatus: boolean | Is the Requisition Item active or not? |
| notes: string | Comments about the Requisition Item |
| quantity: integer (int8) | Quantity specified in the Line Items |
| uom: string | Unit of Measure |
| conversionFactor: integer (int8) | Number of Stock Keeping Units in another Unit of Measure |
| price: number (double) | Price of the Line Item |
| isTaxable: boolean | Is Requisiton Item taxable or not? |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example (200 OK)
Request Example (200 OK)
{
"inventoryNo": "string",
"inventoryDescription": "string",
"locationId": "00000000-0000-0000-0000-000000000000",
"vendorId": "00000000-0000-0000-0000-000000000000",
"vendorItemNo": "string",
"manufacturerId": "00000000-0000-0000-0000-000000000000",
"manufacturerItemNo": "string",
"activeStatus": "boolean",
"notes": "string",
"quantity": "integer (int8)",
"uom": "string",
"conversionFactor": "integer (int8)",
"price": "number (double)",
"isTaxable": "boolean"
}
Request parameters
Parameter |
Explanation |
|---|---|
| requisitionItemId: string (uuid) required in path |
Enter the ID of the Requisition Item here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 404 Not Found | Specified ID is absent in the system. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |