๐ขStock transfer numbering
This page provides a description of the available API routes for managing stock transfer numberings.
When stock transfer is created, the documentNumber
field is generated by server, based on stock transfer numbering settings. API methods listed below provides way to modify numbering settings.
API methods
Get stock transfer numberings
GET
http://{server-address}/stocktransfernumberings
Returns all stock transfer numberings that matches query parameters. Result is of type QueryResult<StockTransferNumbering>
.
Query Parameters
Name | Type | Description |
---|---|---|
id | string | Supports NData syntax. |
isActive | bool | 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 |
type | StockTransferType | Supports NData syntax. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Get stock transfer numbering
GET
http://{server-address}/stocktransfernumberings/{id}
Result is of type StockTransferNumbering.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Unique identifier. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Create stock transfer numbering
POST
http://{server-address}/stocktransfernumberings
Creates new stock transfer numbering. Result is of type StockTransferNumbering.
Required rights
Authorized user must have StockTransferNumberingCreate
right assigned.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
Name | Type | Description |
---|---|---|
(body)* | StockTransferNumbering | Model to create |
Create or update stock transfer numbering
PUT
http://{server-address}/stocktransfernumberings/{id}
Updates existing or creates new stock transfer numbering. Result is of type StockTransferNumbering.
Required rights
Authorized user must have assigned StockTransferNumberingCreate
or StockTransferNumberingUpdate
right.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Unique identifier. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
Name | Type | Description |
---|---|---|
(body)* | StockTransferNumbering | Model to create or update. |
Delete stock transfer numbering
DELETE
http://{server-address}/stocktransfernumberings/{id}
Required rights
Authorized user must have StockTransferNumberingDelete
right assigned.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Unique identifier. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Last updated