Sales | Order

Service to manage entities of type 'Order'.

Overview

URL	api/{tenantKey}/{orgKey}/sales/orders
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Orders
  • GET Orders (paged)
  • GET Order by identifier
  • GET Order by key
  • GET Print Order by identifier
  • GET Print Order by key
  • GET Original Print OrderOriginal by identifier
  • GET Original Print Order by key
  • GET Get Pending Sales Orders
  • GET Get Orders From Online Store
• POST:
  • POST Orders
  • POST Order
• PUT:
  • PUT Set Custom Attribute Order
  • PUT Set Custom Attribute OrderLine
  • PUT Set IsActive Order
  • PUT Set DocumentType Order
  • PUT Set SeriesNumber Order
  • PUT Set Note Order
  • PUT Set BuyerCustomerPartyAddress Order
  • PUT Set AccountingPartyAddress Order
  • PUT Set Discount Order
  • PUT Set Remarks Order
  • PUT Set LoadingPoint Order
  • PUT Set LoadingPointAddress Order
  • PUT Set LoadingStreetName Order
  • PUT Set LoadingBuildingNumber Order
  • PUT Set LoadingPostalZone Order
  • PUT Set LoadingCityName Order
  • PUT Set LoadingCountry Order
  • PUT Set UnloadingPoint Order
  • PUT Set UnloadingPointAddress Order
  • PUT Set UnloadingStreetName Order
  • PUT Set UnloadingBuildingNumber Order
  • PUT Set UnloadingPostalZone Order
  • PUT Set UnloadingCityName Order
  • PUT Set UnloadingCountry Order
  • PUT Set PickingTime Order
  • PUT Set VehiclePlateNumber Order
  • PUT Set NoteToRecipient Order
  • PUT Set PaymentMethod Order
  • PUT Set PaymentTerm Order
  • PUT Set DeliveryTerm Order
  • PUT Set Company Order
  • PUT Set Salesperson Order
  • PUT Set AltAddress Order
  • PUT Set SalesChannel Order
  • PUT Set IsOneTimeCustomer Order
  • PUT Set AccountingAltAddress Order
  • PUT Set DeliveryOnInvoice Order
  • PUT Set Notification Order
  • PUT Set EmailTo Order
  • PUT Set Store Order
  • PUT Set PickupStore Order
  • PUT Set IsSeriesCommunicated Order
  • PUT Set Description OrderLine
  • PUT Set Quantity OrderLine
  • PUT Set UnitPrice OrderLine
  • PUT Set DeliveryDate OrderLine
  • PUT Set Discount1 OrderLine
  • PUT Set Discount2 OrderLine
  • PUT Set Discount3 OrderLine
  • PUT Set ComplementaryDescription OrderLine
  • PUT Set Unit OrderLine
  • PUT Set SalesItem OrderLine
  • PUT Set ItemTaxSchema OrderLine
  • PUT Set Warehouse OrderLine
  • PUT Set DocumentLineStatus OrderLine
  • PUT Set CommitmentReference OrderLine
• DELETE:
  • DELETE Order Line by identifier
  • DELETE Order by identifier
  • DELETE Order by key

All Resources

This service uses the following resources:

• ApiOrderDocumentLinesResource
• ApiOrderResource
• OrderLineResource
• OrderResource
• StandardOrderDocumentLinesResource
• StandardOrderResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• DocumentLineStatus
• DocumentStatus
• ItemType
• OrderNature

GET Operations

GET Orders

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See OrderResource.

Response status codes:

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

Resource URL:

GET Orders (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See OrderResource.

Response status codes:

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

Resource URL:

GET Order by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See OrderResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Order by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.

Response:

When successful, the response body contains the entity record. See OrderResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Print Order by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print Order by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Original Print OrderOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print Order by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Get Pending Sales Orders

Custom operation 'GetPendingSalesOrders'.

Response:

When successful, the response body contains a list of resources of type 'StandardOrderResource'. See StandardOrderResource.

Response status codes:

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

Resource URL:

GET Get Orders From Online Store

Custom operation 'GetOrdersFromOnlineStore'.

The following elements are required:

salesChannelKey	(string) SalesChannelKey.
companyKey	(string) CompanyKey.
buyerCustomerPartyKey	(string) BuyerCustomerPartyKey.

Response:

When successful, the response body contains a list of resources of type 'OrderResource'. See OrderResource.

Response status codes:

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

Resource URL:

POST Operations

POST Orders

Creates a new entity record.

The following elements are required:

orderResource

(ApiOrderResource) The request body should contain the entity record that should be created. See ApiOrderResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiOrderResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Order

Inserts a new 'Order Line' in the 'Order'.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(ApiOrderDocumentLinesResource) The ApiOrderDocumentLinesResource instance. See ApiOrderDocumentLinesResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set AccountingAltAddress Order

Updates the value of attribute 'AccountingAltAddress' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set AccountingPartyAddress Order

Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set AltAddress Order

Updates the value of attribute 'AltAddress' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set BuyerCustomerPartyAddress Order

Updates the value of attribute 'BuyerCustomerPartyAddress' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set CommitmentReference OrderLine

Updates the value of attribute 'CommitmentReference' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Company Order

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set ComplementaryDescription OrderLine

Updates the value of attribute 'ComplementaryDescription' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set DeliveryDate OrderLine

Updates the value of attribute 'DeliveryDate' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set DeliveryOnInvoice Order

Updates the value of attribute 'DeliveryOnInvoice' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set DeliveryTerm Order

Updates the value of attribute 'DeliveryTerm' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Description OrderLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Discount Order

Updates the value of attribute 'Discount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Discount1 OrderLine

Updates the value of attribute 'Discount1' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Discount2 OrderLine

Updates the value of attribute 'Discount2' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Discount3 OrderLine

Updates the value of attribute 'Discount3' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set DocumentLineStatus OrderLine

Updates the value of attribute 'DocumentLineStatus' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum DocumentLineStatus) The request body should contain the new value for the attribute. See DocumentLineStatus.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set DocumentType Order

Updates the value of attribute 'DocumentType' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set EmailTo Order

Updates the value of attribute 'EmailTo' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set IsActive Order

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsOneTimeCustomer Order

Updates the value of attribute 'IsOneTimeCustomer' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set IsSeriesCommunicated Order

Updates the value of attribute 'IsSeriesCommunicated' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set ItemTaxSchema OrderLine

Updates the value of attribute 'ItemTaxSchema' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingBuildingNumber Order

Updates the value of attribute 'LoadingBuildingNumber' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingCityName Order

Updates the value of attribute 'LoadingCityName' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingCountry Order

Updates the value of attribute 'LoadingCountry' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingPoint Order

Updates the value of attribute 'LoadingPoint' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingPointAddress Order

Updates the value of attribute 'LoadingPointAddress' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingPostalZone Order

Updates the value of attribute 'LoadingPostalZone' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set LoadingStreetName Order

Updates the value of attribute 'LoadingStreetName' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Note Order

Updates the value of attribute 'Note' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set NoteToRecipient Order

Updates the value of attribute 'NoteToRecipient' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Notification Order

Updates the value of attribute 'Notification' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set PaymentMethod Order

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set PaymentTerm Order

Updates the value of attribute 'PaymentTerm' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set PickingTime Order

Updates the value of attribute 'PickingTime' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(TimeSpan) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set PickupStore Order

Updates the value of attribute 'PickupStore' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Quantity OrderLine

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Remarks Order

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set SalesChannel Order

Updates the value of attribute 'SalesChannel' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set SalesItem OrderLine

Updates the value of attribute 'SalesItem' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Salesperson Order

Updates the value of attribute 'Salesperson' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set SeriesNumber Order

Updates the value of attribute 'SeriesNumber' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Store Order

Updates the value of attribute 'Store' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Unit OrderLine

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnitPrice OrderLine

Updates the value of attribute 'UnitPrice' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingBuildingNumber Order

Updates the value of attribute 'UnloadingBuildingNumber' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingCityName Order

Updates the value of attribute 'UnloadingCityName' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingCountry Order

Updates the value of attribute 'UnloadingCountry' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingPoint Order

Updates the value of attribute 'UnloadingPoint' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingPointAddress Order

Updates the value of attribute 'UnloadingPointAddress' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingPostalZone Order

Updates the value of attribute 'UnloadingPostalZone' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set UnloadingStreetName Order

Updates the value of attribute 'UnloadingStreetName' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set VehiclePlateNumber Order

Updates the value of attribute 'VehiclePlateNumber' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Warehouse OrderLine

Updates the value of attribute 'Warehouse' in the specified entity record.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Custom Attribute Order

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set Custom Attribute OrderLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE Order Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Order by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Order by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiOrderDocumentLinesResource

The following elements are required:

description	(string) The order's line item description. The default is defined on the sales item.
quantity	(decimal) The order's line item quantity. The default 1.
unitPrice	(decimal) The order's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
deliveryDate	(DateTime) The expected delivery date.
unit	(string) The order's line item sales unit. The default sales unit is defined on the sales item.
salesItem	(string) The sales item representing the good or service to be ordered.
itemTaxSchema	(string) The order's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
documentLineStatus	(enum DocumentLineStatus) The document's line status. The default is Open. See DocumentLineStatus.

The following elements are optional:

discount1	(decimal) The line item's discount 1 percentage. The default is 0.
discount2	(decimal) The line item's discount 2 percentage. The default is 0.
discount3	(decimal) The line item's discount 3 percentage. The default is 0.
complementaryDescription	(string) The order's line item complementary description. The default is defined on the sales item.
warehouse	(string) The order's line item warehouse. The default is defined on the materials item.
commitmentReference	(string) Commitment Reference.

ApiOrderResource

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created in the system.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
buyerCustomerPartyName	(string) The customer's name. It is infered from the customer party.
buyerCustomerPartyAddress	(string) The customer's address. It is infered from the customer party.
accountingParty	(string) The customer designated in the order as the party to whom the order should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
exchangeRate	(decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is infered using the defined exchange rates on the system for the document date and currency.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
currency	(string) The money's 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.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
company	(string) The company's code is the central organizational unit within the system.
deliveryOnInvoice	(bool) Delivery On Invoice.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

taxIncluded	(bool) Indicates whether the unit prices have taxes included or not. The value is infered from the order series.
note	(string) The document's note.
accountingPartyName	(string) The accounting's party name. It is infered from the accounting party.
accountingPartyTaxId	(string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Infered from the accounting party.
accountingPartyAddress	(string) The accounting's customer name. It is infered from the accounting party.
exchangeRateDate	(DateTime) The exchange rate's creation date.
remarks	(string) The order's remarks.
loadingPoint	(string) The physical location where the goods are loaded. The default is the company physical location.
loadingPointAddress	(string) The physical location address where the goods are loaded. The default is the company physical location address.
loadingStreetName	(string) The street name of the physical location where the goods are loaded. The default is the company physical location.
loadingBuildingNumber	(string) The building number of the physical location where the goods are loaded. The default is the company physical location.
loadingPostalZone	(string) The postal zone of the physical location where the goods are loaded. The default is the company physical location.
loadingCityName	(string) The city of the physical location where the goods are loaded. The default is the company physical location.
loadingCountry	(string) The country of the physical location where the goods are loaded. The default is the company country.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is customer address.
unloadingPointAddress	(string) The physical location address where the goods are unloaded. The default is customer address.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
unloadingBuildingNumber	(string) The building number of the physical location where the goods are unloaded. The default is customer address building number.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingCountry	(string) Country.
pickingTime	(TimeSpan) The goods loading date and time from the loading physical location. The default is the order creation date and time.
vehiclePlateNumber	(string) The vehicle's plate used to trasnport the goods.
noteToRecipient	(string) The note to the order recipient.
documentLines	(List of ApiOrderDocumentLinesResource) The order's lines. See ApiOrderDocumentLinesResource.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
economicActivityClassification	(string) The order's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
priceList	(string) The catalogued table values ​​that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
salesperson	(string) The sales person associated to the order. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party.
altAddress	(string) The alternative customer's address key to be used on the order. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
salesChannel	(string) The order's sales channel origin. The default value is defined in the sales setup configuration settings.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
accountingAltAddress	(string) The alternative address for the accounting.
notification	(string) The order's notification configuration. Inferred from the order type.
emailTo	(string) The email(s) to send order notification. Inferred from the notification.
store	(string) The order's sales channel origin. The default value is defined in the documenttype series.
pickupStore	(string) Pickup Store.

OrderLineResource

The following elements are required:

description	(string) The order's line item description. The default is defined on the sales item.
quantity	(decimal) The order's line item quantity. The default 1.
deliveredQuantity	(decimal) The source delivery quantity when the order is transformed from a transport document. Internally determined.
invoicedQuantity	(decimal) Invoiced quantity when the order is transformed to an invoice document. Internally determined.
unitPrice	(decimal) The order's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
deliveryDate	(DateTime) The expected delivery date.
taxTotal	(decimal) The total's amount of taxes for this line. Internally calculated.
allowanceChargeAmount	(decimal) The order's line total discount. Internally calculated.
taxExclusiveAmount	(decimal) The order's line net value. The line value after discounts, excluding taxes. Internally calculated.
grossValue	(decimal) The order's line value before taxes or discounts. Internally calculated.
lineExtensionAmount	(decimal) The order's line payable amount. The line value including taxes and discounts. Internally calculated.
currency	(string) The money's unit. Inferred from the order currency.
unit	(string) The order's line item sales unit. The default sales unit is defined on the sales item.
salesItem	(string) The sales item representing the good or service to be ordered.
itemTaxSchema	(string) The order's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
partyTaxSchema	(string) The order's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
documentLineStatus	(enum DocumentLineStatus) The document's line status. The default is Open. See DocumentLineStatus.
itemType	(enum ItemType) The order's line item type. Inferred from the sales item type. Internally determined. See ItemType.

The following elements are optional:

discount1	(decimal) The line item's discount 1 percentage. The default is 0.
discount2	(decimal) The line item's discount 2 percentage. The default is 0.
discount3	(decimal) The line item's discount 3 percentage. The default is 0.
sourceDoc	(string) The source document using the format {..} when the order is transformed from another document. Internally determined.
sourceDocId	(Guid) The source document identifier when the order is transformed from other source document. Internally determined.
sourceSchemaEntity	(string) The schema entity from originating document, possible values: Orders, Deliveries, GoodsReturns.
sourceDocLine	(int) The source document's line number, when the order was transformed. Internally determined.
sourceDocLineId	(Guid) The source document's line identifier, when the order was transformed. Internally determined.
complementaryDescription	(string) The order's line item complementary description. The default is defined on the sales item.
warehouse	(string) The order's line item warehouse. The default is defined on the materials item.
printAllDiscounts	(string) Discount.
commitmentReference	(string) Commitment Reference.

OrderResource

The following elements are required:

documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created in the system.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
buyerCustomerPartyName	(string) The customer's name. It is infered from the customer party.
buyerCustomerPartyAddress	(string) The customer's address. It is infered from the customer party.
accountingParty	(string) The customer designated in the order as the party to whom the order should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
exchangeRate	(decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is infered using the defined exchange rates on the system for the document date and currency.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
grossValue	(decimal) The total value of goods and services before taxes or discounts. Internally calculated.
allowanceChargeAmount	(decimal) The total's discount over goods and services. Internally calculated.
taxExclusiveAmount	(decimal) The order's total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
taxTotal	(decimal) The total tax value of goods and services. Internally calculated.
payableAmount	(decimal) The order's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
currency	(string) The money's 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.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
company	(string) The company's code is the central organizational unit within the system.
documentStatus	(enum DocumentStatus) The document's status. Internally determined. See DocumentStatus.
autoCreated	(bool) Indicates whether the document was created internally by the system.
orderNature	(enum OrderNature) The order nature: standard or return. Inferred from the order type. See OrderNature.
deliveryOnInvoice	(bool) Delivery On Invoice.
discountInValueAmount	(decimal) Discount In Value.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

taxIncluded	(bool) Indicates whether the unit prices have taxes included or not. The value is infered from the order series.
note	(string) The document's note.
buyerCustomerPartyTaxId	(string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Infered from the customer party.
accountingPartyName	(string) The accounting's party name. It is infered from the accounting party.
accountingPartyTaxId	(string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Infered from the accounting party.
accountingPartyAddress	(string) The accounting's customer name. It is infered from the accounting party.
exchangeRateDate	(DateTime) The exchange rate's creation date.
remarks	(string) The order's remarks.
loadingPoint	(string) The physical location where the goods are loaded. The default is the company physical location.
loadingPointAddress	(string) The physical location address where the goods are loaded. The default is the company physical location address.
loadingStreetName	(string) The street name of the physical location where the goods are loaded. The default is the company physical location.
loadingBuildingNumber	(string) The building number of the physical location where the goods are loaded. The default is the company physical location.
loadingPostalZone	(string) The postal zone of the physical location where the goods are loaded. The default is the company physical location.
loadingCityName	(string) The city of the physical location where the goods are loaded. The default is the company physical location.
loadingCountry	(string) The country of the physical location where the goods are loaded. The default is the company country.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is customer address.
unloadingPointAddress	(string) The physical location address where the goods are unloaded. The default is customer address.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
unloadingBuildingNumber	(string) The building number of the physical location where the goods are unloaded. The default is customer address building number.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingCountry	(string) Country.
pickingTime	(TimeSpan) The goods loading date and time from the loading physical location. The default is the order creation date and time.
vehiclePlateNumber	(string) The vehicle's plate used to trasnport the goods.
legalStamp	(string) In some countries, the documents issued by a company have to contain mandatory remarks, clearly visible in printing, which may vary according to the document. These texts are printed under the signature terms. Internally determined.
isPrinted	(bool) Indicates if the order has been printed. Internally determined.
noteToRecipient	(string) The note to the order recipient.
documentLines	(List of OrderLineResource) The order's lines. See OrderLineResource.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
economicActivityClassification	(string) The order's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
priceList	(string) The catalogued table values ​​that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
salesperson	(string) The sales person associated to the order. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party.
altAddress	(string) The alternative customer's address key to be used on the order. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
salesChannel	(string) The order's sales channel origin. The default value is defined in the sales setup configuration settings.
sourceDoc	(string) The source document using the format {..} when the order is transformed from another document. Internally determined.
sourceDocId	(Guid) The source document identifier when the order is transformed from other source document. Internally determined.
sourceSchemaEntity	(string) The source's schema entity.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
accountingAltAddress	(string) The alternative address for the accounting.
notification	(string) The order's notification configuration. Inferred from the order type.
emailTo	(string) The email(s) to send order notification. Inferred from the notification.
hash	(string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl	(string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
printAllDiscounts	(string) Discount.
aTCUD	(string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
aTQRCode	(string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
store	(string) The order's sales channel origin. The default value is defined in the documenttype series.
pickupStore	(string) Pickup Store.
printedReportName	(string) Printed Report Name.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
fiscalDocumentType	(string) Fiscal Document Type.

StandardOrderDocumentLinesResource

The following elements are required:

unit	(string) The order's line item sales unit. The default sales unit is defined on the sales item.
unitPrice	(decimal) The order's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
itemTaxSchema	(string) The order's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
lineExtensionAmount	(decimal) The order's line payable amount. The line value including taxes and discounts. Internally calculated.
salesItem	(string) The sales item representing the good or service to be ordered.
quantity	(decimal) The order's line item quantity. The default 1.
description	(string) The order's line item description. The default is defined on the sales item.
deliveryDate	(DateTime) The expected delivery date.
itemType	(enum ItemType) The order's line item type. Inferred from the sales item type. Internally determined. See ItemType.

The following elements are optional:

warehouse	(string) The order's line item warehouse. The default is defined on the materials item.
discount1	(decimal) The line item's discount 1 percentage. The default is 0.

StandardOrderResource

The following elements are required:

buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
documentDate	(DateTime) The date when the document is issued.
payableAmount	(decimal) The order's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the order type.
company	(string) The company's code is the central organizational unit within the system.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the sales setup configuration setting.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the order type and serie. Part of the document natural key.
autoCreated	(bool) Indicates whether the document was created internally by the system.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
discountInValueAmount	(decimal) Discount In Value.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
documentLines	(List of StandardOrderDocumentLinesResource) The order's lines. See StandardOrderDocumentLinesResource.
sourceDoc	(string) The source document using the format {..} when the order is transformed from another document. Internally determined.
isPrinted	(bool) Indicates if the order has been printed. Internally determined.
note	(string) The document's note.
hash	(string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
printedReportName	(string) Printed Report Name.
fiscalDocumentType	(string) Fiscal Document Type.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed

ItemType

1	Item
2	Service
3	SpecialSalesTaxes
4	Tax
5	Other

OrderNature

1	StandardOrder
2	ReturnOrder