Purchases | Process Return Order

Service to allow picking of return order to process for memo creation purpose.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Process Return Order
• POST:
  • POST 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) The company code is the central organizational unit within the system. This is a query string parameter.
accountingSupplierParty	(string) The supplier designated in the party as the party to whom should be sent the invoice return. It may or may not be the party to whom the goods or services are delivered. This is a query string parameter.
memoType	(string) The memo's type. This is a query string parameter.
invoiceReceiptNotificationDateFrom	(DateTime?) The invoice receipt notification starting date. Ignored if not set, is used to filter the date in which you received the goods. Only invoice recepit notifications with delivery date greater than or equal to this value will be displayed. Orders will also be displayes in case their document type is set as "Delivery on invoice". This is a query string parameter.
invoiceReceiptNotificationDateUntil	(DateTime?) The invoice receipt notification end date. Ignored if not set, is used to filter the date in which you received the goods. Only invoice recepit notifications with delivery date less than or equal to this value will be displayed. Orders will also be displayes in case their document type is set as "Delivery on invoice". This is a query string parameter.
currency	(string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party. This is a query string parameter.
sourceDoc	(string) The original document to be settled. The source document is usually a return order. Ignored if not set, is used to filter de invoice receipt notifications to the ones whose source document is this document. This is a query string parameter.
deliveryKey	(string) The delivery document. Ignored is not set, is used to filter de invoice receipt notifications to the ones originated by this delivery note. 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 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) Number of lines selected. Internally calculated.

The following elements are optional:

company	(string) The company code is the central organizational unit within the system.
accountingSupplierParty	(string) The supplier designated in the party as the party to whom should be sent the invoice return. It may or may not be the party to whom the goods or services are delivered.
memoType	(string) The memo's type.
invoiceReceiptNotificationDateFrom	(DateTime) The invoice receipt notification starting date. Ignored if not set, is used to filter the date in which you received the goods. Only invoice recepit notifications with delivery date greater than or equal to this value will be displayed. Orders will also be displayes in case their document type is set as "Delivery on invoice".
invoiceReceiptNotificationDateUntil	(DateTime) The invoice receipt notification end date. Ignored if not set, is used to filter the date in which you received the goods. Only invoice recepit notifications with delivery date less than or equal to this value will be displayed. Orders will also be displayes in case their document type is set as "Delivery on invoice".
currency	(string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
sourceDoc	(string) The original document to be settled. The source document is usually a return order. Ignored if not set, is used to filter de invoice receipt notifications to the ones whose source document is this document.
deliveryKey	(string) The delivery document. Ignored is not set, is used to filter de invoice receipt notifications to the ones originated by this delivery note.

InvoiceReceiptReturnOrderLine

The following elements are required:

selected

(bool) Indicates if the line has been selected to be included on the return invoice.

The following elements are optional:

purchasesItem	(string) The purchase item included on invoice. Infered from the invoce receipt notification.
description	(string) The description of the purchase item. Infered from the invoce receipt notification.
quantity	(decimal) The quantity to be included on the return invoice to be created.
deliveryKey	(string) The delivery document. Infered from the invoice receipt notification line.
deliveryLineNumber	(int) The delivery document line number. Infered from the invoice receipt notification line.
orderKey	(string) The order document. Infered from the invoice receipt notification line.
orderLineNumber	(int) The order document line number. Infered from the invoice receipt notification line.
unit	(string) The unit of the purchase item. Infered from the invoce receipt notification.
unitPrice	(decimal) The unit of the purchase item. Infered from the invoce receipt notification.
currency	(string) The currency in use. Infered from the invoce receipt notification.
invoiceReceiptNotificationId	(Guid) The invoice receipt notification starting date. Ignored if not set, is used to filter the date in which you received the goods. Only invoice recepit notifications with delivery date greater than or equal to this value will be displayed.
invoiceReceiptNotificationLineId	(Guid) The invoice receipt notification end date. Ignored if not set, is used to filter the date in which you received the goods. Only invoice recepit notifications with delivery date less than or equal to this value will be displayed.
accountingSupplierParty	(string) The supplier designated in the party as the party to whom should be sent the return invoice. It may or may not be the party to whom the goods or services are delivered.