Purchases | Order

The order represents the document to acquired a list of items or services from a supplier.

Overview

api/{tenantKey}/{orgKey}/purchases/orders

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiOrderDocumentLinesResource
ApiOrderDocumentTaxesResource
ApiOrderResource
MoneyResource
OrderLineResource
OrderResource
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:

api/{tenantKey}/{orgKey}/purchases/orders

GET /purchases/orders

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:

api/{tenantKey}/{orgKey}/purchases/orders?page={page}&pageSize={pageSize}

GET /purchases/orders?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/purchases/orders/{id}

GET /purchases/orders/{id}

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}

GET /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}

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:

api/{tenantKey}/{orgKey}/purchases/orders/{id}/print?template={template}

GET /purchases/orders/{id}/print?template={template}

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

GET /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

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:

api/{tenantKey}/{orgKey}/purchases/orders/{id}/printOriginal?template={template}

GET /purchases/orders/{id}/printOriginal?template={template}

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

GET /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

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:

api/{tenantKey}/{orgKey}/purchases/orders

POST /purchases/orders

POST Order

Inserts a new 'Order Tax' 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 purchases 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	(ApiOrderDocumentTaxesResource) The ApiOrderDocumentTaxesResource instance. See ApiOrderDocumentTaxesResource.

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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes

POST /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines

POST /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingAltAddress

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingAltAddress

PUT Set AccountingParty Order

Updates the value of attribute 'AccountingParty' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingParty

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingParty

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyAddress

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyAddress

PUT Set AccountingPartyName Order

Updates the value of attribute 'AccountingPartyName' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyName

PUT Set AccountingPartyTaxId Order

Updates the value of attribute 'AccountingPartyTaxId' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyTaxId

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyTaxId

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/altAddress

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/altAddress

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/commitmentReference

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/commitmentReference

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/company

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/company

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/complementaryDescription

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/complementaryDescription

PUT Set Currency Order

Updates the value of attribute 'Currency' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/currency

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/currency

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/deliveryDate

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/deliveryDate

PUT Set DeliveryMode Order

Updates the value of attribute 'DeliveryMode' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryMode

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryMode

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryOnInvoice

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryOnInvoice

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryTerm

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryTerm

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description

PUT Set DimensionSet OrderLine

Updates the value of attribute 'DimensionSet' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSet

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSet

PUT Set DimensionSetJson OrderLine

Updates the value of attribute 'DimensionSetJson' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/discount

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/discount

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount1

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount1

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount2

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount2

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount3

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount3

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/documentLineStatus

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/documentLineStatus

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo

PUT Set ExchangeRate Order

Updates the value of attribute 'ExchangeRate' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRate

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRate

PUT Set ExchangeRateDate Order

Updates the value of attribute 'ExchangeRateDate' 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 purchases 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	(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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRateDate

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRateDate

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemTaxSchema

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemTaxSchema

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingBuildingNumber

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingBuildingNumber

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCityName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCityName

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCountry

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCountry

PUT Set LoadingDateTime Order

Updates the value of attribute 'LoadingDateTime' 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 purchases 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	(DateTimeOffset) 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingDateTime

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingDateTime

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPoint

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPoint

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPointAddress

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPointAddress

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPostalZone

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPostalZone

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingStreetName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingStreetName

PUT Set LogisticsPartyId Order

Updates the value of attribute 'LogisticsPartyId' 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 purchases 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	(Guid) 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/logisticsPartyId

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/logisticsPartyId

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/note

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/note

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentTerm

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentTerm

PUT Set PostingDate Order

Updates the value of attribute 'PostingDate' 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 purchases 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	(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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/postingDate

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/postingDate

PUT Set PrintedReportName Order

Updates the value of attribute 'PrintedReportName' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName

PUT Set PurchasesItem OrderLine

Updates the value of attribute 'PurchasesItem' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/purchasesItem

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/purchasesItem

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/quantity

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/quantity

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

PUT Set SellerSupplierParty Order

Updates the value of attribute 'SellerSupplierParty' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierParty

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierParty

PUT Set SellerSupplierPartyAddress Order

Updates the value of attribute 'SellerSupplierPartyAddress' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyAddress

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyAddress

PUT Set SellerSupplierPartyName Order

Updates the value of attribute 'SellerSupplierPartyName' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyName

PUT Set SellerSupplierPartyTaxId Order

Updates the value of attribute 'SellerSupplierPartyTaxId' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyTaxId

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyTaxId

PUT Set SourceOrder OrderLine

Updates the value of attribute 'SourceOrder' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrder

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrder

PUT Set SourceOrderId OrderLine

Updates the value of attribute 'SourceOrderId' 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 purchases 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	(Guid) 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderId

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderId

PUT Set SourceOrderLine OrderLine

Updates the value of attribute 'SourceOrderLine' 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 purchases 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	(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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLine

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLine

PUT Set SourceOrderLineId OrderLine

Updates the value of attribute 'SourceOrderLineId' 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 purchases 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	(Guid) 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLineId

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLineId

PUT Set SourceOrderSchemaEntityId OrderLine

Updates the value of attribute 'SourceOrderSchemaEntityId' 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 purchases 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	(Guid) 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderSchemaEntityId

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderSchemaEntityId

PUT Set TaxIncluded Order

Updates the value of attribute 'TaxIncluded' 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/taxIncluded

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/taxIncluded

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unit

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unit

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitPrice

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitPrice

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingBuildingNumber

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingBuildingNumber

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCityName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCityName

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCountry

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCountry

PUT Set UnloadingDateTime Order

Updates the value of attribute 'UnloadingDateTime' 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 purchases 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	(DateTimeOffset) 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingDateTime

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingDateTime

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPoint

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPoint

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPointAddress

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPointAddress

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPostalZone

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPostalZone

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingStreetName

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingStreetName

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/warehouse

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/warehouse

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}

PUT /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Order Tax 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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}

DELETE /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}

DELETE /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}

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:

api/{tenantKey}/{orgKey}/purchases/orders/{id}

DELETE /purchases/orders/{id}

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 purchases 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:

api/{tenantKey}/{orgKey}/purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}

DELETE /purchases/orders/{companyKey}/{documentType}/{serie}/{seriesNumber}

Resources

ApiOrderDocumentLinesResource

The following elements are required:

description	(string) The order line item description. The default is defined on the purchases item.
quantity	(decimal) The order line item quantity. The default 1.
unitPrice	(MoneyResource) The order line item unit price. See MoneyResource .
deliveryDate	(DateTime) The expected delivery date.
unit	(string) The order line item unit. The default unit is defined on the purchases item.
itemTaxSchema	(string) The order 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 purchases item.
purchasesItem	(string) The purchases item representing the good or service to be ordered.
documentLineStatus	(enum DocumentLineStatus) The document line status. The default is Open. See DocumentLineStatus.

The following elements are optional:

discount1	(decimal) The line item discount 1 percentage. The default is 0.
discount2	(decimal) The line item discount 2 percentage. The default is 0.
discount3	(decimal) The line item discount 3 percentage. The default is 0.
complementaryDescription	(string) The order line item complementary description. The default is defined on the purchases item.
warehouse	(string) The order line item warehouse. The default is defined on the materials item.
dimensionSet	(string) Dimension Set.
dimensionSetJson	(string) Dimension Set Json.
sourceOrder	(string) The order that origin this line.
sourceOrderId	(Guid) The order id that origin this line.
sourceOrderLine	(int) The order line index that origin this line.
sourceOrderLineId	(Guid) The order line id that origin this line.
sourceOrderSchemaEntityId	(Guid) The order schema id that origin this line.
commitmentReference	(string) The state supplier commitment reference.

ApiOrderDocumentTaxesResource

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 purchases setup configuration setting.
company	(string) The company identifies an independent legal entity in the system.
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.
sellerSupplierParty	(string) The supplier designated in the invoice as the party to whom the invoice is sell. It may or may not be the party from whom the goods or services are received. The default is defined on the party.
sellerSupplierPartyName	(string) The seller supplier party name. This attribute is suggested by the system.
accountingParty	(string) The supplier designated in the invoice as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered.
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 percentage. The default is defined on the supplier party.
loadingCountry	(string) The country of the physical location where the goods are loaded.
unloadingCountry	(string) The country of the physical location where the goods are unloaded.
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 supplier party.
paymentMethod	(string) The financial's transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier 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 supplier party.
deliveryOnInvoice	(bool) Will the invoice be used for goods receipt?.

The following elements are optional:

sellerSupplierPartyTaxId	(string) The seller supplier party tax code. This attribute is suggested by the system.
sellerSupplierPartyAddress	(string) The seller supplier party address. This attribute is suggested by the system.
accountingPartyName	(string) The supplier name for accounting purposes.
accountingPartyTaxId	(string) The supplier tax code for accounting purposes.
accountingPartyAddress	(string) The supplier address for accounting purposes.
exchangeRateDate	(DateTime) The exchange rate creation date.
taxIncluded	(bool) Indicates whether the unit prices have taxes included or not. The value is infered from the order series.
loadingPoint	(string) The physical location where the goods are loaded.
loadingPointAddress	(string) The physical location address where the goods are loaded.
loadingStreetName	(string) The street name of the physical location where the goods are loaded.
loadingBuildingNumber	(string) The building number of the physical location where the goods are loaded.
loadingPostalZone	(string) The loading address postal zone.
loadingCityName	(string) The postal zone of the physical location where the goods are loaded.
loadingDateTime	(DateTimeOffset) The date and time when the goods are loaded.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight.
unloadingPointAddress	(string) The physical location address where the goods are unloaded.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded.
unloadingBuildingNumber	(string) The building number of the physical location where the goods are unloaded.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded.
unloadingDateTime	(DateTimeOffset) The date and time when the goods are unloaded.
noteToRecipient	(string) The notes to the invoice recipient.
note	(string) The document note.
remarks	(string) The order remarks.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the supplier party.
documentLines	(List of ApiOrderDocumentLinesResource) The order lines. See ApiOrderDocumentLinesResource.
altAddress	(string) The alternative supplier address key to be used on the order. The alternative addresses keys are defined on the supplier party addresses.
accountingAltAddress	(string) The accounting alternative address.
notification	(string) The order notification configuration. Inferred from the order type.
emailTo	(string) The email(s) to send order notification. Inferred from the notification.
deliveryMode	(string) The Delivery mode. (ex: mail).
logisticsPartyId	(Guid) Logistics Party Id.
dimensionSet	(string) Dimension Set.
dimensionSetJson	(string) Dimension Set Json.
printedReportName	(string) Indicates the report name used to print the document. Internally determined.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

OrderLineResource

The following elements are required:

description	(string) The order line item description. The default is defined on the purchases item.
quantity	(decimal) The order line item quantity. The default 1.
unitPrice	(MoneyResource) The order line item unit price. See MoneyResource .
deliveryDate	(DateTime) The expected delivery date.
grossValue	(MoneyResource) The order line value before taxes or discounts. Internally calculated. See MoneyResource .
allowanceChargeAmount	(MoneyResource) Order line total discount. Internally calculated. See MoneyResource .
taxExclusiveAmount	(MoneyResource) The order line net value. The line value after discounts, excluding taxes. Internally calculated. See MoneyResource .
taxTotal	(MoneyResource) Total amount of taxes for this line. Internally calculated. See MoneyResource .
lineExtensionAmount	(MoneyResource) The order line payable amount. The line value including taxes and discounts. Internally calculated. See MoneyResource .
currency	(string) Money unit. Inferred from the order currency.
unit	(string) The order line item unit. The default unit is defined on the purchases item.
itemTaxSchema	(string) The order 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 purchases item.
partyTaxSchema	(string) The order line item supplier party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the supplier party.
purchasesItem	(string) The purchases item representing the good or service to be ordered.
documentLineStatus	(enum DocumentLineStatus) The document line status. The default is Open. See DocumentLineStatus.
invoicedQuantity	(decimal) The invoiced quantity when the order is transformed to an order document. Internally determined.
receivedQuantity	(decimal) The received quantity.
itemType	(enum ItemType) The order line item type. Inferred from the purchases item type. Internally determined. See ItemType.

The following elements are optional:

discount1	(decimal) The line item discount 1 percentage. The default is 0.
discount2	(decimal) The line item discount 2 percentage. The default is 0.
discount3	(decimal) The line item discount 3 percentage. The default is 0.
complementaryDescription	(string) The order line item complementary description. The default is defined on the purchases item.
warehouse	(string) The order line item warehouse. The default is defined on the materials item.
sourceDoc	(string) Source document using the format {..} when the order is transformed from another document. Internally determined.
sourceDocId	(Guid) Source document id when the order is transformed from other source document. Internally determined.
sourceSchemaEntity	(string) The source document line number, when the order was transformed. Internally determined.
sourceDocLine	(int) The source document line id, when the order was transformed. Internally determined.
sourceDocLineId	(Guid) Source document id when the order is transformed from other source document. Internally determined.
printAllDiscounts	(string) Discount.
dimensionSet	(string) Dimension Set.
dimensionSetJson	(string) Dimension Set Json.
sourceOrder	(string) The order that origin this line.
sourceOrderId	(Guid) The order id that origin this line.
sourceOrderLine	(int) The order line index that origin this line.
sourceOrderLineId	(Guid) The order line id that origin this line.
sourceOrderSchemaEntityId	(Guid) The order schema id that origin this line.
commitmentReference	(string) The state supplier 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 purchases setup configuration setting. (fk) Allowed value: the natural key of a record of type OrderType. These records are accessibly through the OrderTypes service.
company	(string) The company identifies an independent legal entity in the system. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
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. (fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
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.
sellerSupplierParty	(string) The supplier designated in the invoice as the party to whom the invoice is sell. It may or may not be the party from whom the goods or services are received. The default is defined on the party. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
sellerSupplierPartyName	(string) The seller supplier party name. This attribute is suggested by the system.
accountingParty	(string) The supplier designated in the invoice as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
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 percentage. The default is defined on the supplier party.
grossValue	(MoneyResource) The total's value of goods and services before taxes or discounts. See MoneyResource .
allowanceChargeAmount	(MoneyResource) The total's discount over goods and services. Internally calculated. See MoneyResource .
taxExclusiveAmount	(MoneyResource) The order total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated. See MoneyResource .
taxTotal	(MoneyResource) The total's tax value of goods and services. Internally calculated. See MoneyResource .
payableAmount	(MoneyResource) The order payable amount. Total value of goods and services including taxes and discounts. Internally calculated. See MoneyResource .
loadingCountry	(string) The country of the physical location where the goods are loaded. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
unloadingCountry	(string) The country of the physical location where the goods are unloaded. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
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 supplier party. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
paymentMethod	(string) The financial's transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
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 supplier party. (fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
documentStatus	(enum DocumentStatus) The document 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) Will the invoice be used for goods receipt?.

The following elements are optional:

sellerSupplierPartyTaxId	(string) The seller supplier party tax code. This attribute is suggested by the system.
sellerSupplierPartyAddress	(string) The seller supplier party address. This attribute is suggested by the system.
accountingPartyName	(string) The supplier name for accounting purposes.
accountingPartyTaxId	(string) The supplier tax code for accounting purposes.
accountingPartyAddress	(string) The supplier address for accounting purposes.
exchangeRateDate	(DateTime) The exchange rate creation date.
taxIncluded	(bool) Indicates whether the unit prices have taxes included or not. The value is infered from the order series.
loadingPoint	(string) The physical location where the goods are loaded.
loadingPointAddress	(string) The physical location address where the goods are loaded.
loadingStreetName	(string) The street name of the physical location where the goods are loaded.
loadingBuildingNumber	(string) The building number of the physical location where the goods are loaded.
loadingPostalZone	(string) The loading address postal zone.
loadingCityName	(string) The postal zone of the physical location where the goods are loaded.
loadingDateTime	(DateTimeOffset) The date and time when the goods are loaded.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight.
unloadingPointAddress	(string) The physical location address where the goods are unloaded.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded.
unloadingBuildingNumber	(string) The building number of the physical location where the goods are unloaded.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded.
unloadingDateTime	(DateTimeOffset) The date and time when the goods are unloaded.
isPrinted	(bool) Indicates if the order has been printed. This attribute is managed by the system.
noteToRecipient	(string) The notes to the invoice recipient.
note	(string) The document note.
remarks	(string) The order remarks.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the supplier party. (fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
documentLines	(List of OrderLineResource) The order lines. See OrderLineResource.
sourceDoc	(string) Source document using the format {..} when the order is transformed from another document. Internally determined.
sourceDocId	(Guid) Source document id when the order is transformed from other source document. Internally determined.
sourceSchemaEntity	(string) The order source schema entity. (fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
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.
altAddress	(string) The alternative supplier address key to be used on the order. The alternative addresses keys are defined on the supplier party addresses. (fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
accountingAltAddress	(string) The accounting alternative address. (fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
notification	(string) The order notification configuration. Inferred from the order type. (fk) Allowed value: the natural key of a record of type Notification.
emailTo	(string) The email(s) to send order notification. Inferred from the notification.
deliveryMode	(string) The Delivery mode. (ex: mail). (fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
logisticsPartyId	(Guid) Logistics Party Id.
dimensionSet	(string) Dimension Set. (fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
dimensionSetJson	(string) Dimension Set Json.
printedReportName	(string) Indicates the report name used to print the document. Internally determined.
isReprinted	(bool) Indicates if the document has been reprinted. Internally determined.
isSigned	(bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed
3	Processing

ItemType

1	Item
2	Service

OrderNature

1	StandardOrder
2	ReturnOrder