POConfirmations
Get the list of PO Confirmations
Path
GET /odata/POConfirmations
Description
Returns the list of PO Confirmations within a logged organization. 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 |
Restricts the set of items returned. The maximum number of expressions is 100. |
| $orderby: string in query |
Specifies the order in which items are returned. The maximum number of expressions is 5. |
| $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 |
|---|---|
| poConfirmationId: string (uuid) | Unique Identifier of the Purchase Order Confirmation |
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationName: string | Name of the Organization |
| purchaseOrderId: string (uuid) | Unique Identifier of the Purchase Order |
| purchaseOrderNo: string | Number of the Purchase Order |
| sequenceNo: integer (int32) | Number of the Sequence |
| referenceNo: string | Number of the Reference |
| poConfirmationDate: string (date-time) |
Date when the Purchase Order was confirmed |
| isUnresolved: boolean | Is the Purchase Order Confirmation unresolved? |
| dateCreated: string (date-time) | Date when the Purchase Order Confirmation was created |
| lastUpdated: string (date-time) | Last Date when the Purchase Order Confirmation was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Purchase Order Confirmation |
| lastUpdatedByName: string | Name of the last user who updated the Purchase Order Confirmation |
| orderDate: string (date-time) | Date when the Order was made |
| vendorComment: string | Vendor Comments regarding Purchase Order Confirmation |
| notes: string | Comments about the Purchase Order Confirmation |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"poConfirmationId": "00000000-0000-0000-0000-000000000000",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationName": "string",
"purchaseOrderId": "00000000-0000-0000-0000-000000000000",
"purchaseOrderNo": "string",
"sequenceNo": "integer (int32)",
"referenceNo": "string",
"poConfirmationDate": "string (date-time)",
"isUnresolved": "boolean",
"dateCreated": "string (date-time)",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string",
"orderDate": "string (date-time)",
"vendorComment": "string",
"notes": "string"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Get the specified PO Confirmation
Path
GET /odata/POConfirmations({poConfirmationId})
Description
Returns the details of the PO Confirmation specified by ID.
Request parameters
Parameter |
Explanation |
|---|---|
| poConfirmationId: string (uuid) required in path |
Enter the ID of the PO Confirmation 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 |
|---|---|
| poConfirmationId: string (uuid) | Unique Identifier of the Purchase Order Confirmation |
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationName: string | Name of the Organization |
| purchaseOrderId: string (uuid) | Unique Identifier of the Purchase Order |
| purchaseOrderNo: string | Number of the Purchase Order |
| sequenceNo: integer (int32) | Number of the Sequence |
| referenceNo: string | Number of the Reference |
| poConfirmationDate: string (date-time) |
Date when the Purchase Order was confirmed |
| isUnresolved: boolean | Is the Purchase Order Confirmation unresolved? |
| dateCreated: string (date-time) | Date when the Purchase Order Confirmation was created |
| lastUpdated: string (date-time) | Last Date when the Purchase Order Confirmation was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Purchase Order Confirmation |
| lastUpdatedByName: string | Name of the last user who updated the Purchase Order Confirmation |
| orderDate: string (date-time) | Date when the Order was made |
| vendorComment: string | Vendor Comments regarding Purchase Order Confirmation |
| notes: string | Comments about the Purchase Order Confirmation |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"poConfirmationId": "00000000-0000-0000-0000-000000000000",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationName": "string",
"purchaseOrderId": "00000000-0000-0000-0000-000000000000",
"purchaseOrderNo": "string",
"sequenceNo": "integer (int32)",
"referenceNo": "string",
"poConfirmationDate": "string (date-time)",
"isUnresolved": "boolean",
"dateCreated": "string (date-time)",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string",
"orderDate": "string (date-time)",
"vendorComment": "string",
"notes": "string"
}
Get the list of PO Confirmation Items for the specified PO Confirmation
Path
GET /odata/POConfirmations({poConfirmationId})/poConfirmationItems
Description
Returns the list of PO Confirmation Items within the PO Confirmation specified by ID. 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 |
|---|---|
| poConfirmationId: string (uuid) required in path |
Enter the ID of the PO Confirmation here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| $filter: string in query |
Restricts the set of items returned. The maximum number of expressions is 100. |
| $orderby: string in query |
Specifies the order in which items are returned. The maximum number of expressions is 5. |
| $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. |
| 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 |
|---|---|
| poConfirmationItemId: string (uuid) | Unique Identifier of the Purchase Order Confirmation Items |
| poConfirmationId: string (uuid) | Unique Identifier of the Purchase Order Confirmation |
| purchaseOrderId: string (uuid) | Unique Identifier of the Purchase Order |
| purchaseOrderNo: string | Number of the Purchase Order |
| lineItemNo: integer (int32) | Number of the Line Item |
| quantity: integer (int32) | Quantity specified in the Line Items |
| uom: string | Unit of Measure |
| price: number (double) | Price of the Item |
| inventoryNo: string | Identification code of the Inventory Item |
| vendorItemNo: string | Code that is used by the Vendor for the Item identification |
| manufacturer: string | Manufacturer Name |
| manufacturerItemNo: string | Item Number of the Manufacturer |
| inventoryDescription: string | Description of the Inventory Item |
| updatedPOPrice: boolean | Was Purchase Order Price updated or not? |
| updatedInventoryPrice: boolean | Was Inventory Item Price updated or not? |
| dateCreated: string (date-time) | Date when the Purchase Order Confirmation Item was created |
| lastUpdated: string (date-time) | Last Date when the Purchase Order Confirmation Item was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Purchase Order Confirmation Item |
| lastUpdatedByName: string | Name of the last user who updated the Purchase Order Confirmation Item |
| notes: string | Comments about the Purchase Order Confirmation Item |
| isUnresolved: string (boolean) | Is the Purchase Order Confirmation Item unresolved? |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"poConfirmationItemId": "00000000-0000-0000-0000-000000000000",
"poConfirmationId": "00000000-0000-0000-0000-000000000000",
"purchaseOrderId": "00000000-0000-0000-0000-000000000000",
"purchaseOrderNo": "string",
"lineItemNo": "integer (int32)",
"quantity": "integer (int32)",
"uom": "string",
"price": "number (double)",
"inventoryNo": "string",
"vendorItemNo": "string",
"manufacturer": "string",
"manufacturerItemNo": "string",
"inventoryDescription": "string",
"updatedPOPrice": "boolean",
"updatedInventoryPrice": "boolean",
"dateCreated": "string (date-time)",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string",
"notes": "string",
"isUnresolved": "boolean"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}