Purchases | Order

Service to manage entities of type 'Order'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Orders (odata)
  • GET Order by identifier
  • GET Order by key
  • GET Print Order by identifier
  • GET Print Order by identifier (asynchronously)
  • GET Print Order by key
  • GET Print Order by key (asynchronously)
  • GET Original Print Order by identifier
  • GET Original Print Order by identifier (asynchronously)
  • GET Original Print Order by key
  • GET Original Print Order by key (asynchronously)
• POST:
  • POST Orders
  • POST Order Tax
  • POST Order Line
• PUT:
  • PUT Set Custom Attribute Order
  • PUT Set Custom Attribute OrderLine
  • PUT Set IsActive Order
  • PUT Set PostingDate Order
  • PUT Set SellerSupplierPartyAddress Order
  • PUT Set AccountingParty Order
  • PUT Set AccountingPartyName Order
  • PUT Set AccountingPartyTaxId Order
  • PUT Set AccountingPartyAddress Order
  • PUT Set Discount Order
  • PUT Set LoadingPoint Order
  • PUT Set LoadingStreetName Order
  • PUT Set LoadingBuildingNumber Order
  • PUT Set LoadingPostalZone Order
  • PUT Set LoadingCityName Order
  • PUT Set LoadingCountry Order
  • PUT Set UnloadingPoint Order
  • PUT Set UnloadingStreetName Order
  • PUT Set UnloadingBuildingNumber Order
  • PUT Set UnloadingPostalZone Order
  • PUT Set UnloadingCityName Order
  • PUT Set UnloadingCountry Order
  • PUT Set NoteToRecipient Order
  • PUT Set Note Order
  • PUT Set Remarks Order
  • PUT Set PaymentMethod Order
  • PUT Set PaymentTerm Order
  • PUT Set DeliveryTerm Order
  • PUT Set AltAddress Order
  • PUT Set AccountingAltAddress Order
  • PUT Set Description OrderLine
  • PUT Set Quantity OrderLine
  • PUT Set UnitPrice OrderLine
  • PUT Set DeliveryDate OrderLine
  • PUT Set Discount1 OrderLine
  • PUT Set Discount2 OrderLine
  • PUT Set Discount3 OrderLine
  • PUT Set ComplementaryDescription OrderLine
  • PUT Set Unit OrderLine
  • PUT Set ItemTaxSchema OrderLine
  • PUT Set Warehouse OrderLine
  • PUT Set PurchasesItem OrderLine
  • PUT Set DocumentLineStatus OrderLine
  • PUT Set CommitmentReference OrderLine
• DELETE:
  • DELETE Order Tax by identifier
  • DELETE Order Line by identifier
  • DELETE Order by identifier
  • DELETE Order by key

All Resources

This service uses the following resources:

• ApiOrderDocumentLinesResource
• ApiOrderDocumentTaxesResource
• ApiOrderResource
• MoneyResource
• OrderResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• DocumentLineStatus
• DocumentStatus
• OrderNature

GET Operations

GET Orders (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

GET Order by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

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

Response status codes:

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

Resource URL:

GET Order by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the 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:

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 record does not exist.

Resource URL:

GET Print Order by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Print Order by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the 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:

GET Print Order by key (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Original 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 record does not exist.

Resource URL:

GET Original Print Order by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Original Print Order by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the 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:

GET Original Print Order by key (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Operations

POST Orders

Creates a new entity record.

The following elements are required:

orderResource

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

The following elements are optional:

customAttributes

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

Response:

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

Response status codes:

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

Resource URL:

POST Order Tax

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:

POST Order Line

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

DELETE Order by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE Order by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the order's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default order type is defined in the 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:

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.
commitmentReference	(string) 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) A party supplying goods or services. A seller costumer party is different from a contractor since the latter is someone who generally adds value to products for delivery.
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.

The following elements are optional:

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.
loadingPoint	(string) The physical location 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.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight.
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.
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.

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.

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) A party supplying goods or services. A seller costumer party is different from a contractor since the latter is someone who generally adds value to products for delivery. (fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties 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) Delivery On Invoice.
discountInValueAmount	(MoneyResource) Discount In Value. See MoneyResource .

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. These records are accessibly through the Notifications service.
emailTo	(string) The email(s) to send order notification. Inferred from the notification.
printedReportName	(string) Printed Report Name.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed

OrderNature

1	StandardOrder
2	ReturnOrder