Purchases | Order Type

The Order Type represents a purchases order with specific characteristics.

Overview

URL	api/{tenantKey}/{orgKey}/purchasesCore/orderTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET OrderTypes
  • GET OrderTypes (paged)
  • GET OrderType by identifier
  • GET OrderType by key
  • GET Print OrderType by identifier
  • GET Print OrderType by key
  • GET Original Print OrderTypeOriginal by identifier
  • GET Original Print OrderType by key
• POST:
  • POST OrderTypes
  • POST Order Type
• PUT:
  • PUT Set Custom Attribute OrderType
  • PUT Set Custom Attribute OrderTypeSerie
  • PUT Set IsActive OrderType
  • PUT Set Company OrderType
  • PUT Set TypeKey OrderType
  • PUT Set Description OrderType
  • PUT Set OrderNature OrderType
  • PUT Set DefaultInvoiceType OrderType
  • PUT Set DefaultMemoType OrderType
  • PUT Set DefaultGoodsReceiptNoteType OrderType
  • PUT Set DefaultDeliveryType OrderType
  • PUT Set IsInternal OrderType
  • PUT Set DeliveryOnInvoice OrderType
  • PUT Set ContactType OrderType
  • PUT Set Notification OrderType
  • PUT Set CompanyHasDimensions OrderType
  • PUT Set DimensionCombination OrderType
  • PUT Set NumberOfCopies OrderTypeSerie
  • PUT Set IsDefault OrderTypeSerie
  • PUT Set TaxIncluded OrderTypeSerie
• DELETE:
  • DELETE Order Type Serie by identifier
  • DELETE OrderType by identifier
  • DELETE OrderType by key

All Resources

This service uses the following resources:

• ApiOrderTypeDocumentTypeSeriesResource
• ApiOrderTypeResource
• OrderTypeResource
• OrderTypeSerieResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• OrderNature

GET Operations

GET OrderTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET OrderTypes (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 OrderTypeResource.

Response status codes:

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

Resource URL:

GET OrderType 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 OrderTypeResource.

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 OrderType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the order type.

Response:

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

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 OrderType by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

GET Print OrderType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the order type.

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 OrderTypeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

GET Original Print OrderType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the order type.

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:

POST Operations

POST OrderTypes

Creates a new entity record.

The following elements are required:

orderTypeResource

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

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 ApiOrderTypeResource.

Response status codes:

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

Resource URL:

POST Order Type

Inserts a new 'Order Type Serie' in the 'Order Type'.

The following elements are required:

typeKey	(string) The key for the order type.
companyKey	(string) The company key.
value	(ApiOrderTypeDocumentTypeSeriesResource) The ApiOrderTypeDocumentTypeSeriesResource instance. See ApiOrderTypeDocumentTypeSeriesResource.

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 Company OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 CompanyHasDimensions OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set ContactType OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 DefaultDeliveryType OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 DefaultGoodsReceiptNoteType OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 DefaultInvoiceType OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 DefaultMemoType OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 DeliveryOnInvoice OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Description OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 DimensionCombination OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set IsActive OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 IsDefault OrderTypeSerie

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

The following elements are required:

typeKey	(string) The key for the order type.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set IsInternal OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Notification OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 NumberOfCopies OrderTypeSerie

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

The following elements are required:

typeKey	(string) The key for the order type.
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:

PUT Set OrderNature OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
companyKey	(string) The company key.
value	(enum OrderNature) The request body should contain the new value for the attribute. See OrderNature.

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 TaxIncluded OrderTypeSerie

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

The following elements are required:

typeKey	(string) The key for the order type.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set TypeKey OrderType

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

The following elements are required:

typeKey	(string) The key for the order type.
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 OrderType

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

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the order type.
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 OrderTypeSerie

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

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the order type.
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 Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The key for the order type.
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 OrderType 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 OrderType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the order type.

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

ApiOrderTypeDocumentTypeSeriesResource

The following elements are required:

numberOfCopies	(int) The number of copies of the document to print.
isDefault	(bool) Indicates if this is the default serie for the document.
taxIncluded	(bool) When checked, the document unit prices will include taxes.
serie	(string) The range of identification values that group a set of product entities or objects.

ApiOrderTypeResource

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
typeKey	(string) The key for the order type.
orderNature	(enum OrderNature) The nature for the memo type. It can be "credit" or "debit". See OrderNature.
isInternal	(bool) Is internal.
deliveryOnInvoice	(bool) When check, the delivery document will be created with the invoice.
companyHasDimensions	(bool) Flag to know if company has dimensions.

The following elements are optional:

description	(string) The description for the memo type.
documentTypeSeries	(List of ApiOrderTypeDocumentTypeSeriesResource) The list of available series for this document type. See ApiOrderTypeDocumentTypeSeriesResource.
defaultInvoiceType	(string) The default invoice type when the orders are processed.
defaultMemoType	(string) The default memo type when the orders are processed.
defaultGoodsReceiptNoteType	(string) The default goods receipt note type when the orders are processed.
defaultDeliveryType	(string) The default delivery type when the orders are processed.
contactType	(string) The contact type for the memo type.
notification	(string) The default notification for documents with this order type.
dimensionCombination	(string) The dimension combination used for line item dimension determination.

OrderTypeResource

The following elements are required:

company	(string) The company code is the central organizational unit within the system. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
typeKey	(string) The key for the order type.
orderNature	(enum OrderNature) The nature for the memo type. It can be "credit" or "debit". See OrderNature.
isInternal	(bool) Is internal.
deliveryOnInvoice	(bool) When check, the delivery document will be created with the invoice.
companyHasDimensions	(bool) Flag to know if company has dimensions.

The following elements are optional:

description	(string) The description for the memo type.
documentTypeSeries	(List of OrderTypeSerieResource) The list of available series for this document type. See OrderTypeSerieResource.
defaultInvoiceType	(string) The default invoice type when the orders are processed. (fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service.
defaultMemoType	(string) The default memo type when the orders are processed. (fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service.
defaultGoodsReceiptNoteType	(string) The default goods receipt note type when the orders are processed. (fk) Allowed value: the natural key of a record of type GoodsReceiptNoteType. These records are accessibly through the GoodsReceiptNoteTypes service.
defaultDeliveryType	(string) The default delivery type when the orders are processed. (fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service.
contactType	(string) The contact type for the memo type. (fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service.
notification	(string) The default notification for documents with this order type. (fk) Allowed value: the natural key of a record of type Notification.
dimensionCombination	(string) The dimension combination used for line item dimension determination. (fk) Allowed value: the natural key of a record of type DimensionCombination. These records are accessibly through the DimensionCombinations service.

OrderTypeSerieResource

The following elements are required:

numberOfCopies	(int) The number of copies of the document to print.
isDefault	(bool) Indicates if this is the default serie for the document.
taxIncluded	(bool) When checked, the document unit prices will include taxes.
serie	(string) The range of identification values that group a set of product entities or objects.

The following elements are optional:

currentDate	(DateTime) The current date for the order type serie.
currentNumber	(int) The current document’s number.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

OrderNature

1	StandardOrder
2	ReturnOrder