Jasmin Developers - Web API Reference

Materials Management | Stock Transfer Order

Service to manage entities of type 'StockTransferOrder'.

Overview


URL api/{tenantKey}/{orgKey}/materialsManagement/stockTransferOrders
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 StockTransferOrders (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 StockTransferOrderResource.

Response status codes:

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

Resource URL:

GET /materialsManagement/stockTransferOrders/odata

GET StockTransferOrder 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 StockTransferOrderResource.

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 /materialsManagement/stockTransferOrders/{id}

GET StockTransferOrder by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.

Response:

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

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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}

GET Print StockTransferOrder 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 record does not exist.

Resource URL:

GET /materialsManagement/stockTransferOrders/{id}/print?template={template}

GET Print StockTransferOrder by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202 Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /materialsManagement/stockTransferOrders/{id}/printAsync?template={template}

GET Print StockTransferOrder by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.

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:

GET /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

GET Print StockTransferOrder by key (asynchronously)

Prints the specified entity record asynchronously.

The following elements are required:

companyKey (string) The company key.
documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.

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 Location header contains an URL to download the printed file.

Response status codes:

202 Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printAsync

GET Original Print StockTransferOrder 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 record does not exist.

Resource URL:

GET /materialsManagement/stockTransferOrders/{id}/printOriginal?template={template}

GET Original Print StockTransferOrder by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202 Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /materialsManagement/stockTransferOrders/{id}/printOriginalAsync?template={template}

GET Original Print StockTransferOrder by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.

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:

GET /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

GET Original Print StockTransferOrder by key (asynchronously)

Prints the specified entity record asynchronously.

The following elements are required:

companyKey (string) The company key.
documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.

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 Location header contains an URL to download the printed file.

Response status codes:

202 Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginalAsync

POST Operations

POST StockTransferOrders

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /materialsManagement/stockTransferOrders

POST Communicate To Tax Authority

Custom operation 'CommunicateToTaxAuthority'.

The following elements are required:

stockTransferOrderId (Guid) StockTransferOrderId.

Response:

When successful, the response body contains a string.

Resource URL:

POST /materialsManagement/stockTransferOrders/communicateToTaxAuthority/{stockTransferOrderId}

PUT Operations

PUT Set ATDocCodeID StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/aTDocCodeID

PUT Set Description StockTransferOrderLine

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description

PUT Set IsActive StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

PUT Set IsATDocCodeIDEditable StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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:

PUT /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/isATDocCodeIDEditable

PUT Set IsSeriesCommunicated StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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:

PUT /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/isSeriesCommunicated

PUT Set LoadingBuildingNumber StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingBuildingNumber

PUT Set LoadingCityName StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCityName

PUT Set LoadingCountry StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCountry

PUT Set LoadingDateTime StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingDateTime

PUT Set LoadingPoint StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPoint

PUT Set LoadingPostalZone StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPostalZone

PUT Set LoadingStreetName StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingStreetName

PUT Set NoteToRecipient StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient

PUT Set PrintedReportName StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName

PUT Set Reference StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/reference

PUT Set Remarks StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

PUT Set UnloadingBuildingNumber StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingBuildingNumber

PUT Set UnloadingCityName StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCityName

PUT Set UnloadingCountry StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCountry

PUT Set UnloadingDateTime StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingDateTime

PUT Set UnloadingPoint StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPoint

PUT Set UnloadingPostalZone StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPostalZone

PUT Set UnloadingStreetName StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingStreetName

PUT Set UseCurrentDate StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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:

PUT /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/useCurrentDate

PUT Set VehiclePlateNumber StockTransferOrder

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

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}/vehiclePlateNumber

DELETE Operations

DELETE StockTransferOrder 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 /materialsManagement/stockTransferOrders/{id}

DELETE StockTransferOrder by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.

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 /materialsManagement/stockTransferOrders/{companyKey}/{documentType}/{serie}/{seriesNumber}

Resources


ApiStockTransferOrderDocumentLinesResource

The following elements are required:

description (string) Description.
quantity (decimal) Quantity.
unit (string) Unit.
materialsItem (string) Item.


ApiStockTransferOrderResource

The following elements are required:

documentType (string) Document Type.
serie (string) Series.
seriesNumber (int) Number.
loadingPoint (string) Point.
loadingStreetName (string) Street.
loadingBuildingNumber (string) Building Number.
loadingPostalZone (string) Postal Code.
loadingCityName (string) City.
loadingDateTime (DateTimeOffset) Date/Time.
unloadingDateTime (DateTimeOffset) Date/Time.
isATDocCodeIDEditable (bool) Indicates whether de ATDocCodeID is editable or not.
loadingCountry (string) Country.
documentDate (DateTime) Date.
company (string) Company.
sourceWarehouse (string) Source Warehouse.
targetWarehouse (string) Target Warehouse.
useCurrentDate (bool) Use Current Date.
isSeriesCommunicated (bool) Is Series Communicated.

The following elements are optional:

remarks (string) Remarks.
documentLines (List of ApiStockTransferOrderDocumentLinesResource) Document Lines.
See ApiStockTransferOrderDocumentLinesResource.
reference (string) Reference.
unloadingPoint (string) Point.
unloadingStreetName (string) Street.
unloadingBuildingNumber (string) Building Number.
unloadingPostalZone (string) Postal Code.
unloadingCityName (string) City.
vehiclePlateNumber (string) License Plate.
aTDocCodeID (string) AT Code.
accountingPartyName (string) Accounting Party Name.
unloadingCountry (string) Country.
noteToRecipient (string) The note to the stock transfer order recipient.
printedReportName (string) Printed Report Name.


StandardStockTransferOrderDocumentLinesResource

The following elements are required:

description (string) Description.
materialsItem (string) Item.
unit (string) Unit.
quantity (decimal) Quantity.


StandardStockTransferOrderResource

The following elements are required:

autoCreated (bool) Auto Created.
company (string) Company.
currency (string) Currency.
documentDate (DateTime) Date.
documentType (string) Document Type.
postingDate (DateTime) Posting Date.
serie (string) Series.
seriesNumber (int) Number.
sourceWarehouse (string) Source Warehouse.
targetWarehouse (string) Target Warehouse.
loadingBuildingNumber (string) Building Number.
loadingCityName (string) City.
loadingCountry (string) Country.
loadingDateTime (DateTimeOffset) Date/Time.
loadingPoint (string) Point.
loadingPostalZone (string) Postal Code.
loadingStreetName (string) Street.
unloadingDateTime (DateTimeOffset) Date/Time.
useCurrentDate (bool) Use Current Date.
isATDocCodeIDEditable (bool) Indicates whether de ATDocCodeID is editable or not.
isWsCommunicable (bool) Is Ws Communicable.
isSeriesCommunicated (bool) Is Series Communicated.

The following elements are optional:

documentLines (List of StandardStockTransferOrderDocumentLinesResource) Document Lines.
See StandardStockTransferOrderDocumentLinesResource.
reference (string) Reference.
remarks (string) Remarks.
aTDocCodeID (string) AT Code.
unloadingBuildingNumber (string) Building Number.
unloadingCityName (string) City.
unloadingCountry (string) Country.
unloadingPoint (string) Point.
unloadingPostalZone (string) Postal Code.
unloadingStreetName (string) Street.
vehiclePlateNumber (string) License Plate.
noteToRecipient (string) The note to the stock transfer order recipient.
isPrinted (bool) Is Printed.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.
printedReportName (string) Printed Report Name.
fiscalDocumentType (string) The legal fiscal document type defined on the stock transfer order type. Inferred from the stock transfer order type.


StockTransferOrderResource

The following elements are required:

documentType (string) Document Type.
(fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service.
serie (string) Series.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber (int) Number.
payableAmount (MoneyResource) Total.
See MoneyResource .
autoCreated (bool) Auto Created.
loadingPoint (string) Point.
loadingStreetName (string) Street.
loadingBuildingNumber (string) Building Number.
loadingPostalZone (string) Postal Code.
loadingCityName (string) City.
loadingDateTime (DateTimeOffset) Date/Time.
unloadingDateTime (DateTimeOffset) Date/Time.
isATDocCodeIDEditable (bool) Indicates whether de ATDocCodeID is editable or not.
accountingParty (string) Accounting Party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
isWsCommunicable (bool) Is Ws Communicable.
loadingCountry (string) Country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
documentDate (DateTime) Date.
postingDate (DateTime) Posting Date.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
sourceWarehouse (string) Source Warehouse.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.
targetWarehouse (string) Target Warehouse.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.
exchangeRate (decimal) Exchange Rate.
totalValue (MoneyResource) Total Value.
See MoneyResource .
useCurrentDate (bool) Use Current Date.
isExternal (bool) Is External.
isManual (bool) Is Manual.
isSeriesCommunicated (bool) Is Series Communicated.

The following elements are optional:

isPrinted (bool) Is Printed.
hash (string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl (string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
legalStamp (string) Legal Stamp.
remarks (string) Remarks.
documentLines (List of StockTransferOrderLineResource) Document Lines.
See StockTransferOrderLineResource.
reference (string) Reference.
loadingPointAddress (string) Loading Point Address.
unloadingPoint (string) Point.
unloadingStreetName (string) Street.
unloadingBuildingNumber (string) Building Number.
unloadingPostalZone (string) Postal Code.
unloadingCityName (string) City.
unloadingPointAddress (string) Unloading Point Address.
vehiclePlateNumber (string) License Plate.
aTDocCodeID (string) AT Code.
accountingPartyName (string) Accounting Party Name.
accountingPartyTaxId (string) Accounting Party Tax Id.
accountingPartyAddress (string) Accounting Party Address.
unloadingCountry (string) Country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
fiscalDocumentType (string) The legal fiscal document type defined on the stock transfer order type. Inferred from the stock transfer order type.
(fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
manualNumber (int) The delivery's manual serie number. Applicable only when the delivery type series is defined as manual.
manualDate (DateTime) The manual date. Applicable only when the type series is defined as manual.
manualSerie (string) Manual Serie.
noteToRecipient (string) The note to the stock transfer order recipient.
aTCUD (string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
aTQRCode (string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
printedReportName (string) Printed Report Name.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.