Sales | Process Order

The Process Orders end point allows to create invoice based on a order or a delivery. RESERVED FOR INTERNAL USE.

Overview

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

All Operations

This service includes the following operations:

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

All Resources

This service uses the following resources:

• BillingOrder
• BillingOrderLine

GET Operations

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.
accountingCustomerParty	(string) Accounting Customer Party This is a query string parameter.
invoiceType	(string) Invoice 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.
deliveryKey	(string) Delivery 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 BillingOrderLine.

Response status codes:

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

Resource URL:

POST Operations

POST Post Billing Order

This operation allows to create invoice based on a order or a delivery.

The following elements are required:

billingOrder

(BillingOrder) The Open Account Posting represents open items like orders or deliveries to be transformed to invoices or memos.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST Process Order

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

The following elements are required:

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

BillingOrder

The following elements are required:

selectedCount

(int) Selected Count.

The following elements are optional:

company	(string) Company.
accountingCustomerParty	(string) Accounting Customer Party.
invoiceType	(string) Invoice Type.
billingRequestDateFrom	(DateTime) Billing Request Date From.
billingRequestDateUntil	(DateTime) Billing Request Date Until.
currency	(string) Currency.
sourceDoc	(string) Source Doc.
deliveryKey	(string) Delivery Key.
sourceDocId	(Guid) Source Doc Id.
sourceSchemaEntityId	(Guid) Source Schema Entity Id.

BillingOrderLine

The following elements are required:

selected

(bool) Selected.

The following elements are optional:

currency	(string) Currency.
deliveryKey	(string) Delivery Key.
deliveryLineNumber	(int) Delivery Line Number.
description	(string) Description.
orderKey	(string) Order Key.
orderLineNumber	(int) Order Line Number.
quantity	(decimal) Quantity.
salesItem	(string) Sales Item.
unit	(string) Unit.
unitPrice	(decimal) Unit Price.
billingRequestId	(Guid) Billing Request Id.
billingRequestLineId	(Guid) Billing Request Line Id.
sourceDocId	(Guid) Source Doc Id.
sourceSchemaEntityId	(Guid) Source Schema Entity Id.