πStock transfers
This page provides a description of the available API routes for managing stock transfers.
Stock transfer refers to an operation that alters the quantity of products within storage. Various types of stock transfers are defined, each tailored to a specific purpose: increasing, decreasing, or fixing inaccuracies in stock quantity.
Income: This category signifies the purchase of goods from suppliers, leading to an increase in the stock quantity of the purchased items.
Outcome: Applies when goods are withdrawn from storage due to reasons such as expiration, etc.
Transfer: Relocation of goods from one stock location to another within the inventory.
Sale: Comparable to an "outcome," the system generates this transfer type automatically once a ticket is closed. Each sale stock transfer is associated with a single corresponding ticket.
Invoice: Similar to the "outcome" type, the "invoice" transfer may be used when goods are not directly sold through a cash register.
Correction: Generated automatically by system after finalizing of stock-taking process (closing the stock taking). Its role is to fix inaccuracies in stock quantities that were not matched during the stock-taking phase. May contain both positive and negative stock quantity changes.
API methods
Get stock transfers
GET
http://{server-address}/stocktransfers
Returns all stock transfers that matches query parameters. Result is of type QueryResult<StockTransfer>
.
Query Parameters
type
StockTransferType
Supports NData syntax.
id
string
Supports NData syntax.
$skip
int
Pagination property. Describing number of records to skip from beginning of result collection.
$take
int
Pagination property. Maximum count of items to be returned.
$sort
string[]
Comma separated list of property names. Please see NData syntax.
$count
bool
If set to true
, response will not contain items
collection. Use to get resource count, not the resources themselves.
specificSymbol
string
Supports NData syntax.
constantSymbol
string
Supports NData syntax.
variableSymbol
string
Supports NData syntax.
deliveryDate
DateTime
Supports NData syntax.
documentDate
DateTime
Supports NData syntax.
documentNumber
string
Supports NData syntax.
dueDate
DateTime
Supports NData syntax.
closedByUserName
string
Filtering based on closedBy.userName
property. Supports NData syntax.
closedAt
DateTime
Supports NData syntax.
createdByUserName
string
Filtering based on createdBy.userName
property. Supports NData syntax.
partnerCRN
string
Filtering based on partner.crn
property. Supports NData syntax.
companyCRN
string
Filtering based on company.crn
property. Supports NData syntax.
itemSourceOrDestinationPluCode
int
Filtering based on sourcePlu.code
and destinationPlu.code
properties in items
collection. Supports NData syntax.
currencyLabel
string
Supports NData syntax.
discountRate
decimal
Supports NData syntax.
paymentType
string
Supports NData syntax.
deliveryType
string
Supports NData syntax.
itemDestinationPluStockName
string
Filtering based on destinationPlu.stockName
property in items
collection. Supports NData syntax.
itemSourcePluCode
int
Filtering based on sourcePlu.code
property in items
collection. Supports NData syntax.
itemSourcePluStockName
string
Filtering based on sourcePlu.stockName
property in items
collection. Supports NData syntax.
itemSourceOrDestinationPluStockName
string
Filtering based on sourcePlu.stockName
and destinationPlu.stockName
properties in items
collection. Supports NData syntax.
itemDestinationPluCode
int
Filtering based on destinationPlu.code
property in items
collection. Supports NData syntax.
Headers
Authorization*
string
Authorization header with authorization token.
Get stock transfer
GET
http://{server-address}/stocktransfers/{id}
Result is of type StockTransfer.
Path Parameters
id*
string
Stock transfer identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Create stock transfer
POST
http://{server-address}/stocktransfers
Creates new stock transfer. Result is of type StockTransfer.
Required rights
Authorized user must have StockTransferCreate
right assigned. If stock transfer is marked as closed, additional StockTransferClose
right is required.
Headers
Authorization*
string
Authorization header with authorization token.
Request Body
(body)*
StockTransfer
Model to create
Create or update stock transfer
PUT
http://{server-address}/stocktransfers/{id}
Updates existing or creates new stock transfer. Result is of type StockTransfer.
Stock transfer marked as closed cannot be updated.
Required rights
Authorized user must have assigned StockTransferCreate
or StockTransferUpdate
right. If stock transfer is created by another user, additional StockTransferUpdateAny
right is required. If stock transfer is marked as closed, additional StockTransferClose
right is required.
Path Parameters
id*
string
Stock transfer identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Request Body
(body)*
StockTransfer
Model to create or update.
Delete stock transfer
DELETE
http://{server-address}/stocktransfers/{id}
Required rights
Authorized user must have StockTransferDelete
right assigned.
Path Parameters
id*
string
Stock transfer identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Last updated