Goods Receipt | Process Order
Service to process entities of type 'Orders'.
Overview
| URL | api/{tenantKey}/{orgKey}/goodsReceipt/processOrders |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
GET Process Order
Returns the list of entity records that can be processed by the 'GoodsReceiptNotes' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| company | (string) The company code is the central organizational unit within the system. |
The following elements are optional:
| warehouse | (string) The order warehouse. The default is defined on the materials item. This is a query string parameter. |
| deliveryDateFrom | (DateTime?) The initial date to deliver. This is a query string parameter. |
| deliveryDateUntil | (DateTime?) The final date to deliver. This is a query string parameter. |
| loadingPoint | (string) The address where the good is loaded. This is a query string parameter. |
| unloadingPoint | (string) The address where the good is unloaded. This is a query string parameter. |
| party | (string) The customer from whom the goods are ordered. This is a query string parameter. |
| goodsReceiptNoteType | (string) The goods receipt's type. This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See GoodsReceiptOrderLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/goodsReceipt/processOrders/{pageIndex}/{pageSize}?warehouse={warehouse}&deliveryDateFrom={deliveryDateFrom}&deliveryDateUntil={deliveryDateUntil}&loadingPoint={loadingPoint}&unloadingPoint={unloadingPoint}&party={party}&goodsReceiptNoteType={goodsReceiptNoteType}
GET /goodsReceipt/processOrders/{pageIndex}/{pageSize}?warehouse={warehouse}&deliveryDateFrom={deliveryDateFrom}&deliveryDateUntil={deliveryDateUntil}&loadingPoint={loadingPoint}&unloadingPoint={unloadingPoint}&party={party}&goodsReceiptNoteType={goodsReceiptNoteType}
POST Process Order
Instructs the 'GoodsReceiptNotes' service to process the specified entity records.
The following elements are required:
| list | (GoodsReceiptOrderLine) List of the entity records that should be processed. See GoodsReceiptOrderLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/goodsReceipt/processOrders/{companyKey}
POST /goodsReceipt/processOrders/{companyKey}
Resources
GoodsReceiptOrder
The following elements are required:
| selectedCount | (int) Number of lines selected. Internally calculated. |
| company | (string) The company code is the central organizational unit within the system. |
The following elements are optional:
| warehouse | (string) The order warehouse. The default is defined on the materials item. |
| deliveryDateFrom | (DateTime) The initial date to deliver. |
| deliveryDateUntil | (DateTime) The final date to deliver. |
| loadingPoint | (string) The address where the good is loaded. |
| unloadingPoint | (string) The address where the good is unloaded. |
| party | (string) The customer from whom the goods are ordered. |
| goodsReceiptNoteType | (string) The goods receipt's type. |
GoodsReceiptOrderLine
The following elements are required:
| selected | (bool) Indicates if the line has been selected. |
| hasDiscountInValue | (bool) Has Discount In Value. |
The following elements are optional:
| description | (string) The goods receipt oders line item's description. The default is defined on the order item. |
| originalQuantity | (decimal) The initial goods quantity. |
| openQuantity | (decimal) The quantity that was not yet processed. |
| quantity | (decimal) The quantity available to deliver. |
| unit | (string) The goods receipt order line item order's unit. The default order unit is defined on the order item. |
| sourceDocKey | (string) The source document identifier, when the order was transformed. Internally determined. |
| sourceDocLineNumber | (int) The source document line number, when the order was transformed. Internally determined. |
| receiptNotificationId | (Guid) The receipt notification identifier for the goods receipt order line. |
| receiptNotificationLineId | (Guid) The receipt notification line identifier for the goods receipt order line. |
| party | (string) The customer from whom the goods are ordered. |
| item | (string) The original order's item. |
| deliveryDate | (DateTime) The delivery date. |