Valuekeep Developers - Web API Reference

Parts and Inventory | Part Issue

Service to manage entities of type 'PartIssue'.

Overview


URL api/{tenantKey}/{orgKey}/inventoryManagement/partIssues
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET PartIssues (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 PartIssueResource.

Response status codes:

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

Resource URL:

GET /inventoryManagement/partIssues/odata

GET PartIssue 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 PartIssueResource.

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 /inventoryManagement/partIssues/{id}

GET PartIssue by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
partIssueKey (string) Part Issue.

Response:

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

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 /inventoryManagement/partIssues/{companyKey}/{partIssueKey}

POST Operations

POST PartIssues

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /inventoryManagement/partIssues

PUT Operations

PUT Set Company PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/company

PUT Set ConsumptionKey PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/consumptionKey

PUT Set Currency PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/currency

PUT Set Currency PartIssueLine

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/partIssueLines/{lineId}/currency

PUT Set Date PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
companyKey (string) The company key.
value (DateTimeOffset) 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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/date

PUT Set Description PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/description

PUT Set ExchangeRate PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
companyKey (string) The company key.
value (decimal) 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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/exchangeRate

PUT Set ExchangeRateDate PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
companyKey (string) The company key.
value (DateTime) 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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/exchangeRateDate

PUT Set IsActive PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/isActive

PUT Set IssueDate PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
companyKey (string) The company key.
value (DateTimeOffset) 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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/issueDate

PUT Set PartIssueKey PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/partIssueKey

PUT Set Remarks PartIssue

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

The following elements are required:

partIssueKey (string) Part Issue.
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/remarks

PUT Set Total PartIssueLine

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

The following elements are required:

partIssueKey (string) Part Issue.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/partIssueLines/{lineId}/total

PUT Set UnitPrice PartIssueLine

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

The following elements are required:

partIssueKey (string) Part Issue.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/partIssueLines/{lineId}/unitPrice

PUT Set Custom Attribute PartIssue

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
partIssueKey (string) Part Issue
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 /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/{customAttributeName}

PUT Set Custom Attribute PartIssueLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
partIssueKey (string) Part Issue
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:

PUT /inventoryManagement/partIssues/{companyKey}/{partIssueKey}/partIssueLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE PartIssue 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 /inventoryManagement/partIssues/{id}

DELETE PartIssue by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
partIssueKey (string) Part Issue.

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 /inventoryManagement/partIssues/{companyKey}/{partIssueKey}

Resources


ApiPartIssuePartIssueLinesResource

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.


ApiPartIssueResource

The following elements are required:

partIssueKey (string) Part Issue.
description (string) Description.
documentType (string) Document Type.
warehouse (string) Warehouse.
company (string) Company.
exchangeRate (decimal) Exchange Rate.
issueDate (DateTimeOffset) Issue Date.

The following elements are optional:

date (DateTimeOffset) Date.
partIssueLines (List of ApiPartIssuePartIssueLinesResource) Part Issue Lines.
See ApiPartIssuePartIssueLinesResource.
remarks (string) Remarks.
currency (string) Currency.
exchangeRateDate (DateTime) Exchange Rate Date.
consumptionKey (string) Consumption.


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.



PartIssueResource

The following elements are required:

partIssueKey (string) Part Issue.
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.
exchangeRate (decimal) Exchange Rate.
issueDate (DateTimeOffset) Issue Date.

The following elements are optional:

date (DateTimeOffset) Date.
partIssueLines (List of PartIssueLineResource) Part Issue Lines.
See PartIssueLineResource.
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.
consumptionKey (string) Consumption.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.