Purchases | Process Order
The Process Orders end point allows to create invoice based on the order.
Overview
| URL | api/{tenantKey}/{orgKey}/invoiceReceipt/processOrders |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Process Order
Returns the list of entity records that can be processed by the 'Invoices' 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). |
The following elements are optional:
| company | (string) Company This is a query string parameter. |
| accountingSupplierParty | (string) Accounting Supplier Party This is a query string parameter. |
| invoiceType | (string) Invoice Type This is a query string parameter. |
| invoiceReceiptNotificationDateFrom | (DateTime?) Invoice Receipt Notification Date From This is a query string parameter. |
| invoiceReceiptNotificationDateUntil | (DateTime?) Invoice Receipt Notification Date Until This is a query string parameter. |
| currency | (string) Currency This is a query string parameter. |
| sourceDoc | (string) Source Doc This is a query string parameter. |
| goodsReceiptNoteKey | (string) Goods Receipt Note Key This is a query string parameter. |
| sourceDocId | (Guid?) Source Doc Id This is a query string parameter. |
| sourceSchemaEntityId | (Guid?) Source Schema Entity Id This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See InvoiceReceiptOrderLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/processOrders/{pageIndex}/{pageSize}?company={company}&accountingSupplierParty={accountingSupplierParty}&invoiceType={invoiceType}&invoiceReceiptNotificationDateFrom={invoiceReceiptNotificationDateFrom}&invoiceReceiptNotificationDateUntil={invoiceReceiptNotificationDateUntil}¤cy={currency}&sourceDoc={sourceDoc}&goodsReceiptNoteKey={goodsReceiptNoteKey}&sourceDocId={sourceDocId}&sourceSchemaEntityId={sourceSchemaEntityId}
GET /invoiceReceipt/processOrders/{pageIndex}/{pageSize}?company={company}&accountingSupplierParty={accountingSupplierParty}&invoiceType={invoiceType}&invoiceReceiptNotificationDateFrom={invoiceReceiptNotificationDateFrom}&invoiceReceiptNotificationDateUntil={invoiceReceiptNotificationDateUntil}¤cy={currency}&sourceDoc={sourceDoc}&goodsReceiptNoteKey={goodsReceiptNoteKey}&sourceDocId={sourceDocId}&sourceSchemaEntityId={sourceSchemaEntityId}
POST Post Invoice Receipt Order
Custom operation 'PostInvoiceReceiptOrder'.
The following elements are required:
| invoiceReceiptOrder | (InvoiceReceiptOrder) InvoiceReceiptOrder. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/processOrders/postInvoiceReceiptOrder
POST /invoiceReceipt/processOrders/postInvoiceReceiptOrder
POST Process Order
Instructs the 'Invoices' service to process the specified entity records.
The following elements are required:
| list | (InvoiceReceiptOrderLine) List of the entity records that should be processed. See InvoiceReceiptOrderLine. |
| 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}/invoiceReceipt/processOrders/{companyKey}
POST /invoiceReceipt/processOrders/{companyKey}
Resources
InvoiceReceiptOrder
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| company | (string) Company. |
| accountingSupplierParty | (string) Accounting Supplier Party. |
| invoiceType | (string) Invoice Type. |
| invoiceReceiptNotificationDateFrom | (DateTime) Invoice Receipt Notification Date From. |
| invoiceReceiptNotificationDateUntil | (DateTime) Invoice Receipt Notification Date Until. |
| currency | (string) Currency. |
| sourceDoc | (string) Source Doc. |
| goodsReceiptNoteKey | (string) Goods Receipt Note Key. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |
InvoiceReceiptOrderLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| currency | (string) Currency. |
| goodsReceiptNoteKey | (string) Goods Receipt Note Key. |
| goodsReceiptNoteLineNumber | (int) Goods Receipt Note Line Number. |
| description | (string) Description. |
| orderKey | (string) Order Key. |
| orderLineNumber | (int) Order Line Number. |
| quantity | (decimal) Quantity. |
| purchasesItem | (string) Purchases Item. |
| unit | (string) Unit. |
| unitPrice | (decimal) Unit Price. |
| invoiceReceiptNotificationId | (Guid) Invoice Receipt Notification Id. |
| invoiceReceiptNotificationLineId | (Guid) Invoice Receipt Notification Line Id. |