Purchases | Process Return Order

The Process Return Orders end point allows to create memos based on the return order.

Overview

URL	api/{tenantKey}/{orgKey}/invoiceReceipt/processReturnOrders
Methods Supported	POST, GET

All Operations

This service includes the following operations:

• POST:
  • POST Post Invoice Receipt Return Order
  • POST Process Return Order
• GET:
  • GET Process Return Order

All Resources

This service uses the following resources:

• InvoiceReceiptReturnOrder
• InvoiceReceiptReturnOrderLine

GET Operations

GET Process Return Order

Returns the list of entity records that can be processed by the 'Memos' 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.
memoType	(string) Memo 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.
deliveryKey	(string) Delivery Key This is a query string parameter.
memoReason	(string) Memo Reason This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See InvoiceReceiptReturnOrderLine.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Operations

POST Post Invoice Receipt Return Order

Custom operation 'PostInvoiceReceiptReturnOrder'.

The following elements are required:

invoiceReceiptReturnOrder

(InvoiceReceiptReturnOrder) InvoiceReceiptReturnOrder.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST Process Return Order

Instructs the 'Memos' service to process the specified entity records.

The following elements are required:

list	(InvoiceReceiptReturnOrderLine) List of the entity records that should be processed. See InvoiceReceiptReturnOrderLine.
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:

Resources

InvoiceReceiptReturnOrder

The following elements are required:

selectedCount

(int) Selected Count.

The following elements are optional:

company	(string) Company.
accountingSupplierParty	(string) Accounting Supplier Party.
memoType	(string) Memo Type.
invoiceReceiptNotificationDateFrom	(DateTime) Invoice Receipt Notification Date From.
invoiceReceiptNotificationDateUntil	(DateTime) Invoice Receipt Notification Date Until.
currency	(string) Currency.
sourceDoc	(string) Source Doc.
deliveryKey	(string) Delivery Key.
memoReason	(string) Memo Reason.

InvoiceReceiptReturnOrderLine

The following elements are required:

selected

(bool) Selected.

The following elements are optional:

purchasesItem	(string) Purchases Item.
description	(string) Description.
quantity	(decimal) Quantity.
deliveryKey	(string) Delivery Key.
deliveryLineNumber	(int) Delivery Line Number.
orderKey	(string) Order Key.
orderLineNumber	(int) Order Line Number.
unit	(string) Unit.
unitPrice	(decimal) Unit Price.
currency	(string) Currency.
invoiceReceiptNotificationId	(Guid) Invoice Receipt Notification Id.
invoiceReceiptNotificationLineId	(Guid) Invoice Receipt Notification Line Id.
accountingSupplierParty	(string) Accounting Supplier Party.