Parts and Inventory | Part Entrie
Service to manage entities of type 'PartEntrie'.
Overview
| URL | api/{tenantKey}/{orgKey}/inventoryManagement/partEntries |
| Methods Supported | GET, POST, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- DELETE:
All Resources
This service uses the following resources:
GET PartEntries (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 PartEntrieResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET PartEntrie 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 PartEntrieResource. |
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 PartEntrie by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| partEntrieKey | (string) Part Entrie. |
Response:
| When successful, the response body contains the entity record. See PartEntrieResource. |
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 PartEntries
Creates a new entity record.
The following elements are required:
| partEntrieResource | (ApiPartEntrieResource) The request body should contain the entity record that should be created. See ApiPartEntrieResource. |
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 ApiPartEntrieResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Custom Attribute PartEntrie
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| partEntrieKey | (string) Part Entrie |
| 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 PartEntrieLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| partEntrieKey | (string) Part Entrie |
| 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 PartEntrie 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 PartEntrie by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| partEntrieKey | (string) Part Entrie. |
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
ApiPartEntriePartEntrieLinesResource
The following elements are required:
| inventoryPart | (string) Inventory Part. |
| quantity | (decimal) Quantity. |
| unit | (string) Unit. |
| unitPrice | (MoneyResource) Unit Price.
See MoneyResource . |
| total | (MoneyResource) Total.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| description | (string) Description. |
| requisitionLineId | (Guid) Requisition Line Id. |
ApiPartEntrieResource
The following elements are required:
| partEntrieKey | (string) Part Entrie. |
| description | (string) Description. |
| documentType | (string) Document Type. |
| warehouse | (string) Warehouse. |
| company | (string) Company. |
| entrieDate | (DateTimeOffset) Entry Date. |
| exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
| date | (DateTimeOffset) Date. |
| partEntrieLines | (List of ApiPartEntriePartEntrieLinesResource) Part Entrie Lines.
See ApiPartEntriePartEntrieLinesResource. |
| remarks | (string) Remarks. |
| currency | (string) Currency. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
MoneyResource
The following elements are required:
| amount | (decimal) The amount. |
The following elements are optional:
| baseAmount | (decimal) The base amount. |
| reportingAmount | (decimal) The reporting amount. |
| fractionDigits | (int) The fraction digits. |
| symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
PartEntrieResource
The following elements are required:
| partEntrieKey | (string) Part Entrie. |
| description | (string) Description. |
| documentType | (string) Document Type.
(fk) Allowed value: the natural key of a record of type DocumentType. These records are accessibly through the DocumentTypes service. |
| warehouse | (string) Warehouse.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| entrieDate | (DateTimeOffset) Entry Date. |
| exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
| date | (DateTimeOffset) Date. |
| partEntrieLines | (List of PartEntrieLineResource) Part Entrie Lines.
See PartEntrieLineResource. |
| remarks | (string) Remarks. |
| currency | (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |