Sales | Order Type

Service to manage entities of type 'OrderType'.

Overview

api/{tenantKey}/{orgKey}/salesCore/orderTypes

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

All Operations

This service includes the following operations:

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

All Resources

This service uses the following resources:

ApiOrderTypeDocumentTypeSeriesResource
ApiOrderTypeResource
OrderTypeResource

All Enumerations

This service uses the following enumerations:

CommunicationType
OrderNature

GET Operations

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/orderTypes/odata

GET /salesCore/orderTypes/odata

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}/salesCore/orderTypes/{id}

GET /salesCore/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 order's type key.

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}/salesCore/orderTypes/{companyKey}/{typeKey}

GET /salesCore/orderTypes/{companyKey}/{typeKey}

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}/salesCore/orderTypes

POST /salesCore/orderTypes

POST Order Type Serie

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

The following elements are required:

typeKey	(string) The order's type key.
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}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries

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

PUT Operations

PUT Set ATManualCommunication OrderTypeSerie

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

The following elements are required:

typeKey	(string) The order's type key.
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}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

PUT Set ATValidationCode OrderTypeSerie

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

PUT Set CommunicationType OrderTypeSerie

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

The following elements are required:

typeKey	(string) The order's type key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum CommunicationType) The request body should contain the new value for the attribute. See CommunicationType.

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}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/communicationType

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/communicationType

PUT Set Company OrderType

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

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

PUT Set EconomicActivityClass OrderTypeSerie

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/economicActivityClass

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/economicActivityClass

PUT Set FiscalDocumentType OrderType

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/orderTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT Set IsActive OrderType

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
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}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
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}/salesCore/orderTypes/{companyKey}/{typeKey}/orderNature

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

PUT Set SalesChannel OrderTypeSerie

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/salesChannel

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/salesChannel

PUT Set Store OrderTypeSerie

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/store

PUT /salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/store

PUT Set TaxIncluded OrderTypeSerie

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

The following elements are required:

typeKey	(string) The order's type key.
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}/salesCore/orderTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT /salesCore/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 order's type key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

DELETE /salesCore/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}/salesCore/orderTypes/{id}

DELETE /salesCore/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 order's type key.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

DELETE /salesCore/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.
aTManualCommunication	(bool) Manual Communication.
communicationType	(enum CommunicationType) The type of comunication to be used. This is applicable only to Portuguese companies. See CommunicationType.

The following elements are optional:

economicActivityClass	(string) Indicates the company's activity.
salesChannel	(string) Indicates the sales channel used by default for this document type series.
aTValidationCode	(string) Validation Code.
store	(string) Indicates the store used by default for this document type series. Must belong to the indicated sales channel.

ApiOrderTypeResource

The following elements are required:

company	(string) The order's type company. The company's code is the central organizational unit within the system.
typeKey	(string) The order's type key.
deliveryOnInvoice	(bool) Indicates the default delivery type when the orders are processed.
orderNature	(enum OrderNature) The nature for the memo type. It can be "credit" or "debit". See OrderNature.
isInternal	(bool) Indicates whether the document was created by the system.

The following elements are optional:

description	(string) The order's type description.
documentTypeSeries	(List of ApiOrderTypeDocumentTypeSeriesResource) The order's type details. See ApiOrderTypeDocumentTypeSeriesResource.
fiscalDocumentType	(string) The fiscal's document type.
defaultInvoiceType	(string) Indicates the default invoice type when the orders are processed.
defaultMemoType	(string) Indicates the default memo type when the orders are processed.
defaultDeliveryType	(string) Indicates the default delivery type when the orders are processed.
defaultGoodsReceiptNoteType	(string) Indicates the default goods receipt note type when the orders are processed.
contactType	(string) The contact type for the order type.
notification	(string) The default notification for documents with this order type.

OrderTypeResource

The following elements are required:

company	(string) The order's type company. The company's 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 order's type key.
deliveryOnInvoice	(bool) Indicates the default delivery type when the orders are processed.
orderNature	(enum OrderNature) The nature for the memo type. It can be "credit" or "debit". See OrderNature.
isInternal	(bool) Indicates whether the document was created by the system.
isPortugueseCompany	(bool) Indicates if the invoice type is targeted at a company that is portuguese.

The following elements are optional:

description	(string) The order's type description.
documentTypeSeries	(List of OrderTypeSerieResource) The order's type details. See OrderTypeSerieResource.
fiscalDocumentType	(string) The fiscal's document type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
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.
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.
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.
contactType	(string) The contact type for the order 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.

Enumerations

CommunicationType

1	WebService
2	SAFT
3	NoCommunication
4	Manual

OrderNature

1	StandardOrder
2	ReturnOrder