Materials Management | Stock Transfer Order

The stock transfer order is used to manage information about a transfer of stock between a two warehouses.

Overview

URL	api/{tenantKey}/{orgKey}/materialsManagement/stockTransferOrders
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET StockTransferOrders
  • GET StockTransferOrders (paged)
  • GET StockTransferOrder by identifier
  • GET StockTransferOrder by key
  • GET Print StockTransferOrder by identifier
  • GET Print StockTransferOrder by key
  • GET Original Print StockTransferOrderOriginal by identifier
  • GET Original Print StockTransferOrder by key
• POST:
  • POST StockTransferOrders
• PUT:
  • PUT Set Custom Attribute StockTransferOrder
  • PUT Set Custom Attribute StockTransferOrderLine
  • PUT Set IsActive StockTransferOrder
  • PUT Set Remarks StockTransferOrder
  • PUT Set Reference StockTransferOrder
  • PUT Set LoadingPoint StockTransferOrder
  • PUT Set LoadingStreetName StockTransferOrder
  • PUT Set LoadingBuildingNumber StockTransferOrder
  • PUT Set LoadingPostalZone StockTransferOrder
  • PUT Set LoadingCityName StockTransferOrder
  • PUT Set LoadingCountry StockTransferOrder
  • PUT Set LoadingDateTime StockTransferOrder
  • PUT Set UnloadingPoint StockTransferOrder
  • PUT Set UnloadingStreetName StockTransferOrder
  • PUT Set UnloadingBuildingNumber StockTransferOrder
  • PUT Set UnloadingPostalZone StockTransferOrder
  • PUT Set UnloadingCityName StockTransferOrder
  • PUT Set UnloadingCountry StockTransferOrder
  • PUT Set VehiclePlateNumber StockTransferOrder
  • PUT Set UnloadingDateTime StockTransferOrder
  • PUT Set ATDocCodeID StockTransferOrder
  • PUT Set IsATDocCodeIDEditable StockTransferOrder
  • PUT Set AccountingParty StockTransferOrder
  • PUT Set UseCurrentDate StockTransferOrder
  • PUT Set Currency StockTransferOrder
  • PUT Set TaxExclusiveAmount StockTransferOrder
  • PUT Set GrossValue StockTransferOrder
  • PUT Set AccountingPartyName StockTransferOrder
  • PUT Set AccountingPartyTaxId StockTransferOrder
  • PUT Set AccountingPartyAddress StockTransferOrder
  • PUT Set DocumentDate StockTransferOrder
  • PUT Set PostingDate StockTransferOrder
  • PUT Set IsWsCommunicable StockTransferOrder
  • PUT Set TaxTotal StockTransferOrder
  • PUT Set JournalType StockTransferOrder
  • PUT Set IsEndCustomer StockTransferOrder
  • PUT Set PrintedReportName StockTransferOrder
  • PUT Set IsSeriesCommunicated StockTransferOrder
  • PUT Set Description StockTransferOrderLine
  • PUT Set Currency StockTransferOrderLine
  • PUT Set ItemType StockTransferOrderLine
  • PUT Set DimensionSet StockTransferOrderLine
  • PUT Set DimensionSetJson StockTransferOrderLine
• DELETE:
  • DELETE StockTransferOrder by identifier
  • DELETE StockTransferOrder by key

All Resources

This service uses the following resources:

• ApiStockTransferOrderDocumentLinesResource
• ApiStockTransferOrderResource
• MoneyResource
• StockTransferOrderLineResource
• StockTransferOrderResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• ItemType

GET Operations

GET StockTransferOrders

Returns the list of all the entity records available.

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 StockTransferOrders (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 StockTransferOrderResource.

Response status codes:

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

Resource URL:

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 StockTransferOrder by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.

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 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 resord does not exist.

Resource URL:

GET Print StockTransferOrder by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.

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 Original Print StockTransferOrderOriginal 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:

GET Original Print StockTransferOrder by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.

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:

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.

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set AccountingParty StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set AccountingPartyAddress StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set AccountingPartyName StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set AccountingPartyTaxId StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set ATDocCodeID StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set Currency StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set Currency StockTransferOrderLine

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set Description StockTransferOrderLine

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set DimensionSet StockTransferOrderLine

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set DimensionSetJson StockTransferOrderLine

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set DocumentDate StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set GrossValue StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set IsActive StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set IsATDocCodeIDEditable StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set IsEndCustomer StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set IsSeriesCommunicated StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set IsWsCommunicable StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set ItemType StockTransferOrderLine

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ItemType) The request body should contain the new value for the attribute. See ItemType.

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 Set JournalType StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingBuildingNumber StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingCityName StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingCountry StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingDateTime StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingPoint StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingPostalZone StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set LoadingStreetName StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set PostingDate StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set PrintedReportName StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set Reference StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set Remarks StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set TaxExclusiveAmount StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set TaxTotal StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingBuildingNumber StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingCityName StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingCountry StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingDateTime StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingPoint StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingPostalZone StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UnloadingStreetName StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set UseCurrentDate StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set VehiclePlateNumber StockTransferOrder

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

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 Set Custom Attribute StockTransferOrder

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

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 StockTransferOrderLine

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

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
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 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 StockTransferOrder by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.

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

ApiStockTransferOrderDocumentLinesResource

The following elements are required:

description	(string) The description of the item.
quantity	(decimal) The quantity of the item to be transfered.
unit	(string) Item unit.
materialsItem	(string) The selected item of the stock transfer order.
currency	(string) The document currency.

The following elements are optional:

itemType	(enum ItemType) The item type. Example if is item or service. See ItemType.
dimensionSet	(string) The dimension set.
dimensionSetJson	(string) Dimension Set Json.

ApiStockTransferOrderResource

The following elements are required:

documentType	(string) Identifies the type of stock transfer.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
company	(string) The company where the transfer is posted.
loadingPoint	(string) Loading warehouse key.
loadingStreetName	(string) Street name of the loading warehouse. Internally filled, but can be changed on create.
loadingBuildingNumber	(string) Building number of the loading warehouse. Internally filled, but can be changed on create.
loadingPostalZone	(string) Post zone of the loading warehouse. Internally filled, but can be changed on create.
loadingCityName	(string) City of the loading warehouse. Internally filled, but can be changed on create.
loadingCountry	(string) Country of the loading warehouse. Internally filled, but can be changed on create.
loadingDateTime	(DateTimeOffset) Loading date. By default use the system date.
unloadingCountry	(string) Country of the unloading warehouse. Internally filled, but can be changed on create.
unloadingDateTime	(DateTimeOffset) Unloading date. By default use the sistem date.
isATDocCodeIDEditable	(bool) Indicates if the ATDocCodeID is editable or not. Is true if not comunicate to AT.
accountingParty	(string) Accounting party identifier. Internally filled Is the party referent to the company.
useCurrentDate	(bool) By default is true. if false user can edit the loading date on create.
currency	(string) The document currency.
sourceWarehouse	(string) Source warehouse id.
targetWarehouse	(string) Target warehouse id.
taxExclusiveAmount	(MoneyResource) The tax exclusive amount of the original document. See MoneyResource .
grossValue	(MoneyResource) The delivery's line value before taxes or discounts. Internally calculated. See MoneyResource .
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date where the document is posted.
isWsCommunicable	(bool) Is true if the serie is set to communicate from WS.
taxTotal	(MoneyResource) The tax total of the original document. See MoneyResource .
journalType	(string) Journal type from the accounting document.
isEndCustomer	(bool) Internal flag that indicates if the party is end customer.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

hashControl	(string) Version control.
remarks	(string) Stock transfer remark.
reference	(string) The document's reference.
unloadingPoint	(string) Unloading warehouse key.
unloadingStreetName	(string) Street name of the unloading warehouse. Internally filled, but can be changed on create.
unloadingBuildingNumber	(string) Building number of the unloading warehouse. Internally filled, but can be changed on create.
unloadingPostalZone	(string) Post zone of the unloading warehouse. Internally filled, but can be changed on create.
unloadingCityName	(string) City of the unloading warehouse. Internally filled, but can be changed on create.
vehiclePlateNumber	(string) Identify the vehicle plate number that do the transfer.
aTDocCodeID	(string) Code internally filled. Is filled with the WS to AT.
documentLines	(List of ApiStockTransferOrderDocumentLinesResource) Reference to document line "StockTransferOrderLine". See ApiStockTransferOrderDocumentLinesResource.
accountingPartyName	(string) Accounting party name. Internally filled based on Accounting Party.
accountingPartyTaxId	(string) Accounting party tax id. Internally filled based on Accounting Party.
accountingPartyAddress	(string) Accounting party address. Internally filled based on Accounting Party.
printedReportName	(string) Indicates the report name used to print the document. Internally determined.

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.

StockTransferOrderLineResource

The following elements are required:

description	(string) The description of the item.
quantity	(decimal) The quantity of the item to be transfered.
unitPrice	(MoneyResource) The price per unit of the item. See MoneyResource .
unitCost	(MoneyResource) Item calculated unit cost. See MoneyResource .
conversionFactor	(decimal) The line convertion factor.
value	(MoneyResource) The quantity multiplied by the unit price. See MoneyResource .
unit	(string) Item unit.
baseUnit	(string) Item base unity.
materialsItem	(string) The selected item of the stock transfer order.
currency	(string) The document currency.

The following elements are optional:

inventoryAmount	(decimal) Item amount of inventary.
itemType	(enum ItemType) The item type. Example if is item or service. See ItemType.
dimensionSet	(string) The dimension set.
dimensionSetJson	(string) Dimension Set Json.

StockTransferOrderResource

The following elements are required:

documentType	(string) Identifies the type of stock transfer. (fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service.
serie	(string) Serie of the transfer only is allowed series on the FiscalDocumentType. (fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber	(int) Auto generate number. Auto increment based on the Serie.
company	(string) The company where the transfer is posted. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
payableAmount	(MoneyResource) The payable amount. Total value of goods and services including taxes and discounts. Internally calculated. See MoneyResource .
autoCreated	(bool) Set to true if the document is auto created.
loadingPoint	(string) Loading warehouse key.
loadingStreetName	(string) Street name of the loading warehouse. Internally filled, but can be changed on create.
loadingBuildingNumber	(string) Building number of the loading warehouse. Internally filled, but can be changed on create.
loadingPostalZone	(string) Post zone of the loading warehouse. Internally filled, but can be changed on create.
loadingCityName	(string) City of the loading warehouse. Internally filled, but can be changed on create.
loadingCountry	(string) Country of the loading warehouse. Internally filled, but can be changed on create. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
loadingDateTime	(DateTimeOffset) Loading date. By default use the system date.
unloadingCountry	(string) Country of the unloading warehouse. Internally filled, but can be changed on create. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
unloadingDateTime	(DateTimeOffset) Unloading date. By default use the sistem date.
isATDocCodeIDEditable	(bool) Indicates if the ATDocCodeID is editable or not. Is true if not comunicate to AT.
accountingParty	(string) Accounting party identifier. Internally filled Is the party referent to the company. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
exchangeRate	(decimal) The exchange rate between transaction currency and base currency. The base currency is set at the organization level.
totalValue	(MoneyResource) The total amount for the document. Internally calculated. See MoneyResource .
useCurrentDate	(bool) By default is true. if false user can edit the loading date on create.
isExternal	(bool) The flag indicates if the delivery type is serie is external.
isManual	(bool) The flag indicates if the delivery type is serie is manual.
currency	(string) The document 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 id. (fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.
targetWarehouse	(string) Target warehouse id. (fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.
taxExclusiveAmount	(MoneyResource) The tax exclusive amount of the original document. See MoneyResource .
grossValue	(MoneyResource) The delivery's line value before taxes or discounts. Internally calculated. See MoneyResource .
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date where the document is posted.
isWsCommunicable	(bool) Is true if the serie is set to communicate from WS.
taxTotal	(MoneyResource) The tax total of the original document. See MoneyResource .
journalType	(string) Journal type from the accounting document. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
journalNumber	(int) Number of the accounting document, is internally filled.
isEndCustomer	(bool) Internal flag that indicates if the party is end customer.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

isPrinted	(bool) The flag indicates if the document has been printed. Internally determined.
hash	(string) Document signature.
hashControl	(string) Version control.
legalStamp	(string) Stamp added to the printed document.
remarks	(string) Stock transfer remark.
reference	(string) The document's reference.
loadingPointAddress	(string) Address of the loading warehouse. Internally filled, but can be changed on create.
unloadingPoint	(string) Unloading warehouse key.
unloadingStreetName	(string) Street name of the unloading warehouse. Internally filled, but can be changed on create.
unloadingBuildingNumber	(string) Building number of the unloading warehouse. Internally filled, but can be changed on create.
unloadingPostalZone	(string) Post zone of the unloading warehouse. Internally filled, but can be changed on create.
unloadingCityName	(string) City of the unloading warehouse. Internally filled, but can be changed on create.
unloadingPointAddress	(string) Address of the unloading warehouse. Internally filled, but can be changed on create.
vehiclePlateNumber	(string) Identify the vehicle plate number that do the transfer.
aTDocCodeID	(string) Code internally filled. Is filled with the WS to AT.
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) The stocktranferorder's manual serie. Applicable only when the invoice type series is defined as manual.
fiscalDocumentType	(string) The document type of the stock transfer. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
documentLines	(List of StockTransferOrderLineResource) Reference to document line "StockTransferOrderLine". See StockTransferOrderLineResource.
accountingPartyName	(string) Accounting party name. Internally filled based on Accounting Party.
accountingPartyTaxId	(string) Accounting party tax id. Internally filled based on Accounting Party.
accountingPartyAddress	(string) Accounting party address. Internally filled based on Accounting Party.
ledger	(string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. (fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
accountingDocument	(string) The accounting document that was assigned in accounting.
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) Indicates the report name used to print the document. Internally determined.
isReprinted	(bool) Indicates if the document has been reprinted. Internally determined.
isSigned	(bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.
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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

ItemType

1	Item
2	Service