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) 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. |
| invoiceType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. The default delivery type is defined in the sales configuration setting. 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's unit. Inferred from the order currency. This is a query string parameter. |
| sourceDoc | (string) The source document. This is a query string parameter. |
| deliveryKey | (string) The delivery's key. 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:
api/{tenantKey}/{orgKey}/billing/processOrders/{pageIndex}/{pageSize}?company={company}&accountingCustomerParty={accountingCustomerParty}&invoiceType={invoiceType}&billingRequestDateFrom={billingRequestDateFrom}&billingRequestDateUntil={billingRequestDateUntil}¤cy={currency}&sourceDoc={sourceDoc}&deliveryKey={deliveryKey}
GET /billing/processOrders/{pageIndex}/{pageSize}?company={company}&accountingCustomerParty={accountingCustomerParty}&invoiceType={invoiceType}&billingRequestDateFrom={billingRequestDateFrom}&billingRequestDateUntil={billingRequestDateUntil}¤cy={currency}&sourceDoc={sourceDoc}&deliveryKey={deliveryKey}
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:
api/{tenantKey}/{orgKey}/billing/processOrders/{companyKey}
POST /billing/processOrders/{companyKey}
Resources
BillingOrder
The following elements are required:
| selectedCount | (int) The number of lines selected. |
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. |
| invoiceType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. The default delivery type is defined in the sales configuration setting. |
| billingRequestDateFrom | (DateTime) The start date for the billing request. |
| billingRequestDateUntil | (DateTime) The end date for the billing request. |
| currency | (string) The money's unit. Inferred from the order currency. |
| sourceDoc | (string) The source document. |
| deliveryKey | (string) The delivery's key. |
BillingOrderLine
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:
| currency | (string) The money's unit. Inferred from the order currency. |
| deliveryKey | (string) The delivery's key. |
| deliveryLineNumber | (int) The delivery's line number. |
| description | (string) The description for the line. |
| orderKey | (string) The order's key. |
| orderLineNumber | (int) The order's line number. |
| originalQuantity | (decimal) The billing request line item quantity. Infered from the source document line. |
| openQuantity | (decimal) It indicates the current open quantity of the original document line. One original document document line can be partially settled over multiple billings. Internally determined. Infered from source document line. |
| quantity | (decimal) The quantity. |
| salesItem | (string) The sales item. |
| unit | (string) The unit. |
| unitPrice | (decimal) The unit price. |
| billingRequestId | (Guid) The billing request's identifier. |
| billingRequestLineId | (Guid) The billing request's line identifier. |
| salesChannel | (string) The Sales Channel of the original document. |
| store | (string) The Store of the original document. |
| company | (string) The company code is the central organizational unit within the system. |