Logistics | Goods Receipt Type
The Goods Receipt Note Type represents a purchases order with specific characteristics.
Overview
| URL | api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET GoodsReceiptNoteTypes
- GET GoodsReceiptNoteTypes (paged)
- GET GoodsReceiptNoteType by identifier
- GET GoodsReceiptNoteType by key
- GET Print GoodsReceiptNoteType by identifier
- GET Print GoodsReceiptNoteType by key
- GET Original Print GoodsReceiptNoteTypeOriginal by identifier
- GET Original Print GoodsReceiptNoteType by key
- POST:
-
PUT:
- PUT Set Custom Attribute GoodsReceiptNoteType
- PUT Set Custom Attribute GoodsReceiptNoteTypeSerie
- PUT Set IsActive GoodsReceiptNoteType
- PUT Set TypeKey GoodsReceiptNoteType
- PUT Set Company GoodsReceiptNoteType
- PUT Set Description GoodsReceiptNoteType
- PUT Set IsInternal GoodsReceiptNoteType
- PUT Set ContactType GoodsReceiptNoteType
- PUT Set Notification GoodsReceiptNoteType
- PUT Set JournalType GoodsReceiptNoteType
- PUT Set NumberOfCopies GoodsReceiptNoteTypeSerie
- PUT Set IsDefault GoodsReceiptNoteTypeSerie
- DELETE:
All Resources
This service uses the following resources:
GET GoodsReceiptNoteTypes
Returns the list of all the entity records available.
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
GET /logisticsCore/goodsReceiptNoteTypes
GET GoodsReceiptNoteTypes (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 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?page={page}&pageSize={pageSize}
GET /logisticsCore/goodsReceiptNoteTypes?page={page}&pageSize={pageSize}
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}
GET Print GoodsReceiptNoteType 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}/logisticsCore/goodsReceiptNoteTypes/{id}/print?template={template}
GET /logisticsCore/goodsReceiptNoteTypes/{id}/print?template={template}
GET Print GoodsReceiptNoteType by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/print
GET /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/print
GET Original Print GoodsReceiptNoteTypeOriginal 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}/logisticsCore/goodsReceiptNoteTypes/{id}/printOriginal?template={template}
GET /logisticsCore/goodsReceiptNoteTypes/{id}/printOriginal?template={template}
GET Original Print GoodsReceiptNoteType by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the goods receipt note 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}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/printOriginal
GET /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/printOriginal
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. |
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 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 Type
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. |
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:
api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries
POST /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries
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 JournalType GoodsReceiptNoteType
Updates the value of attribute 'JournalType' 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}/journalType
PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/journalType
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
PUT Set Custom Attribute GoodsReceiptNoteType
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 goods receipt note 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:
api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/{customAttributeName}
PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/{customAttributeName}
PUT Set Custom Attribute GoodsReceiptNoteTypeSerie
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 goods receipt note 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:
api/{tenantKey}/{orgKey}/logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/{customAttributeName}
PUT /logisticsCore/goodsReceiptNoteTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/{customAttributeName}
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) The serie for the goods receipt type serie. |
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) System flag set for internal goods receipt. |
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. |
| journalType | (string) The journal type to be used for the account posting. |
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) System flag set for internal goods receipt. |
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. |
| journalType | (string) The journal type to be used for the account posting.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service. |
GoodsReceiptNoteTypeSerieResource
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) The serie for the goods receipt type serie. |
The following elements are optional:
| currentDate | (DateTime) The current goods receipt type's date. |
| currentNumber | (int) The current goods receipt type serie's number. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |