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. |
| accountingCustomerParty | (string) The accounting's customer party. This is a query string parameter. |
| memoType | (string) The memo's type. This is a query string parameter. |
| billingRequestDateFrom | (DateTime?) The start date for the billing request. This is a query string parameter. |
| billingRequestDateUntil | (DateTime?) The end date for the billing request. 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 customer party. This is a query string parameter. |
| sourceDoc | (string) The source document. This is a query string parameter. |
| goodsReceiptNoteKey | (string) The key for the goods receipt note. 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:
api/{tenantKey}/{orgKey}/billing/processReturnOrders/{pageIndex}/{pageSize}?company={company}&accountingCustomerParty={accountingCustomerParty}&memoType={memoType}&billingRequestDateFrom={billingRequestDateFrom}&billingRequestDateUntil={billingRequestDateUntil}¤cy={currency}&sourceDoc={sourceDoc}&goodsReceiptNoteKey={goodsReceiptNoteKey}
GET /billing/processReturnOrders/{pageIndex}/{pageSize}?company={company}&accountingCustomerParty={accountingCustomerParty}&memoType={memoType}&billingRequestDateFrom={billingRequestDateFrom}&billingRequestDateUntil={billingRequestDateUntil}¤cy={currency}&sourceDoc={sourceDoc}&goodsReceiptNoteKey={goodsReceiptNoteKey}
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:
api/{tenantKey}/{orgKey}/billing/processReturnOrders/{companyKey}
POST /billing/processReturnOrders/{companyKey}
Resources
BillingReturnOrder
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| company | (string) The company code is the central organizational unit within the system. |
| accountingCustomerParty | (string) The accounting's customer party. |
| memoType | (string) The memo's type. |
| billingRequestDateFrom | (DateTime) The start date for the billing request. |
| billingRequestDateUntil | (DateTime) The end date for the billing request. |
| 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 customer party. |
| sourceDoc | (string) The source document. |
| goodsReceiptNoteKey | (string) The key for the goods receipt note. |
BillingReturnOrderLine
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:
| salesItem | (string) The sales item. |
| 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 customer party. |
| goodsReceiptNoteKey | (string) The key for the goods receipt note. |
| goodsReceiptNoteLineNumber | (int) The goods receipt's note line number. |
| description | (string) The description for the line. |
| orderKey | (string) The order's key. |
| orderLineNumber | (int) The order's line number. |
| quantity | (decimal) The line's quantity. |
| unit | (string) The line's unit. |
| unitPrice | (decimal) The line's unit price. |
| billingRequestId | (Guid) The billing request's identifier. |
| billingRequestLineId | (Guid) The billing request's line identifier. |
| billingDate | (DateTimeOffset) The billing's date. |
| accountingCustomerParty | (string) The accounting's customer party,. |
| salesChannel | (string) Sales Channel. |
| store | (string) Store. |
| company | (string) The company code is the central organizational unit within the system. |