Sales | Process Return Order

The Process Return Orders end point allows to create memo based on a order or a Goods Receipt. RESERVED FOR INTERNAL USE.

Overview

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

All Operations

This service includes the following operations:

• POST:
  • POST Post Billing Return Order
  • POST Process Return Order
• GET:
  • GET Process Return Order

All Resources

This service uses the following resources:

• BillingReturnOrder
• BillingReturnOrderLine

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.
accountingCustomerParty	(string) Accounting Customer Party This is a query string parameter.
memoType	(string) Memo Type This is a query string parameter.
billingRequestDateFrom	(DateTime?) Billing Request Date From This is a query string parameter.
billingRequestDateUntil	(DateTime?) Billing Request 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.
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 BillingReturnOrderLine.

Response status codes:

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

Resource URL:

POST Operations

POST Post Billing Return Order

This operation allows to create memo based on a order or a Goods Receipt.

The following elements are required:

billingOrder

(BillingReturnOrder) The Open Account Posting represents open items like return orders or goods receipts to be transformed to invoices or memos.

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

BillingReturnOrder

The following elements are required:

selectedCount

(int) Selected Count.

The following elements are optional:

company	(string) Company.
accountingCustomerParty	(string) Accounting Customer Party.
memoType	(string) Memo Type.
billingRequestDateFrom	(DateTime) Billing Request Date From.
billingRequestDateUntil	(DateTime) Billing Request Date Until.
currency	(string) Currency.
sourceDoc	(string) Source Doc.
goodsReceiptNoteKey	(string) Goods Receipt Note Key.
memoReason	(string) Memo Reason.

BillingReturnOrderLine

The following elements are required:

selected

(bool) Selected.

The following elements are optional:

salesItem	(string) Sales Item.
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.
unit	(string) Unit.
unitPrice	(decimal) Unit Price.
billingRequestId	(Guid) Billing Request Id.
billingRequestLineId	(Guid) Billing Request Line Id.
billingDate	(DateTime) Billing Date.
accountingCustomerParty	(string) Accounting Customer Party.