Purchases | Order Type

Service to manage entities of type 'OrderType'.

Overview

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST OrderTypes
- POST Order Type
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiOrderTypeDocumentTypeSeriesResource
ApiOrderTypeResource
OrderTypeResource
OrderTypeSerieResource

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes

GET /purchasesCore/orderTypes

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes?page={page}&pageSize={pageSize}

GET /purchasesCore/orderTypes?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{id}

GET /purchasesCore/orderTypes/{id}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}

GET /purchasesCore/orderTypes/{companyKey}/{typeKey}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{id}/print?template={template}

GET /purchasesCore/orderTypes/{id}/print?template={template}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/print

GET /purchasesCore/orderTypes/{companyKey}/{typeKey}/print

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{id}/printOriginal?template={template}

GET /purchasesCore/orderTypes/{id}/printOriginal?template={template}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/printOriginal

GET /purchasesCore/orderTypes/{companyKey}/{typeKey}/printOriginal

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.

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes

POST /purchasesCore/orderTypes

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.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/company

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/company

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/contactType

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/contactType

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultDeliveryType

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultDeliveryType

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultGoodsReceiptNoteType

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultGoodsReceiptNoteType

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultInvoiceType

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultInvoiceType

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultMemoType

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/defaultMemoType

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/deliveryOnInvoice

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/deliveryOnInvoice

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/description

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/description

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/isActive

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/isActive

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/isInternal

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/isInternal

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/notification

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/notification

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/orderNature

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/orderNature

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/typeKey

PUT /purchasesCore/orderTypes/{companyKey}/{typeKey}/typeKey

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE /purchasesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{id}

DELETE /purchasesCore/orderTypes/{id}

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:

api/{tenantKey}/{orgKey}/purchasesCore/orderTypes/{companyKey}/{typeKey}

DELETE /purchasesCore/orderTypes/{companyKey}/{typeKey}

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.

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) Indicates the default invoice type when the orders are processed.
defaultMemoType	(string) Indicates the default memo type when the orders are processed.
defaultGoodsReceiptNoteType	(string) Indicates the default goods receipt note type when the orders are processed.
defaultDeliveryType	(string) Indicates 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.

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.

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) Indicates 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) Indicates 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) Indicates 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) Indicates 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. These records are accessibly through the Notifications 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.

Enumerations

OrderNature

1	StandardOrder
2	ReturnOrder