Logistics | Goods Receipt Type

Service to manage entities of type 'GoodsReceiptNoteType'.

Overview

api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes

URL	api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST GoodsReceiptNoteTypes
- POST Goods Receipt Note Type Serie
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource
ApiGoodsReceiptNoteTypeResource
GoodsReceiptNoteTypeResource

GET Operations

GET GoodsReceiptNoteTypes (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 GoodsReceiptNoteTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes/odata

GET /logisticsCore/goodsReceiptNoteTypes/odata

GET GoodsReceiptNoteType 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 GoodsReceiptNoteTypeResource.

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}/logisticsCore/goodsReceiptNoteTypes/{id}

GET /logisticsCore/goodsReceiptNoteTypes/{id}

GET GoodsReceiptNoteType 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 goods receipt note type.

Response:

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

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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}

GET /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}

POST Operations

POST GoodsReceiptNoteTypes

Creates a new entity record.

The following elements are required:

goodsReceiptNoteTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes

POST /logisticsCore/goodsReceiptNoteTypes

POST Goods Receipt Note Type Serie

Inserts a new 'Goods Receipt Note Type Serie' in the 'Goods Receipt Type'.

The following elements are required:

typeKey	(string) The key for the goods receipt note type.
companyKey	(string) The company key.
value	(ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource) The ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource instance. See ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource.

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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries

PUT Operations

PUT Set Company GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/company

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/company

PUT Set ContactType GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/contactType

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/contactType

PUT Set Description GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/description

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/description

PUT Set IsActive GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/isActive

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/isActive

PUT Set IsDefault GoodsReceiptNoteTypeSerie

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT Set IsInternal GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/isInternal

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/isInternal

PUT Set Notification GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/notification

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/notification

PUT Set NumberOfCopies GoodsReceiptNoteTypeSerie

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT Set TypeKey GoodsReceiptNoteType

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

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/typeKey

PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/typeKey

DELETE Operations

DELETE Goods Receipt Note Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE GoodsReceiptNoteType 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}/logisticsCore/goodsReceiptNoteTypes/{id}

DELETE /logisticsCore/goodsReceiptNoteTypes/{id}

DELETE GoodsReceiptNoteType 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 goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}

DELETE /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}

Resources

ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource

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.
serie	(string) Series.

ApiGoodsReceiptNoteTypeResource

The following elements are required:

typeKey	(string) The key for the goods receipt note type.
company	(string) The company for the goods receipt note type. The company code is the central organizational unit within the system.
isInternal	(bool) Is Internal.

The following elements are optional:

documentTypeSeries	(List of ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource) List of available series for this document type. See ApiGoodsReceiptNoteTypeDocumentTypeSeriesResource.
description	(string) The description for the goods receipt note type.
contactType	(string) The contact type for the goods receipt note type.
notification	(string) The notification for the goods receipt note type.

GoodsReceiptNoteTypeResource

The following elements are required:

typeKey	(string) The key for the goods receipt note type.
company	(string) The company for the goods receipt note type. 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.
isInternal	(bool) Is Internal.

The following elements are optional:

documentTypeSeries	(List of GoodsReceiptNoteTypeSerieResource) List of available series for this document type. See GoodsReceiptNoteTypeSerieResource.
description	(string) The description for the goods receipt note type.
contactType	(string) The contact type for the goods receipt note type. (fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service.
notification	(string) The notification for the goods receipt note type. (fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service.