Podpora.nextis.cz - Příspěvky [cs]

API GetDocumentItems

2021-09-30T14:14:46Z

Chrzaszcz:

==== Description ====
Method gives You overview of existing document items in system.

==== Exact name ====
<code>API_GetDocumentItems</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|ReceiptID
|int
|ID of delivery note from delivery note list (see relation)
| API_GetDeliveryNote.ID
|-
|DocumentID
|int
|ID of invoices from invoices list (see relation)
| API_GetInvoices.ID
|-
|DocumentID2
|int
|ID of original invoices from invoices list (see relation)
| API_GetInvoices.ID
|-
|ProductID
|int
|ID of product from products list (see relation)
| API_GetProducts.ID
|-
|StorageCardID
|int
|ID of stock dispositions from stock dispositions list (see relation)
| API_GetStockDispositions.ID
|-
|MeasureUnitID
|int
|ID of unit from units list (see relation)
| API_GetUnits.ID
|-
|VATID
|int
|ID of VAT rates from VAT rates list (see relation)
| API_GetVATRates.ID
|-
|TypeID
|int
|Type ID.
1 - Product,

2 - Service,

7 - Text,

500 - CreditNote,

999 - Round
|
|-
|IssueQuantity
|numeric(12,4)
|Issue quantity
|
|-
|RetailPricePerPiece
|decimal(18,4)
|Retail price per piece
|
|-
|PurchPrice
|decimal(19,4)
|Purch price
|
|-
|PurchasePriceInCurrency
|decimal(19,4)
|Purchase price in currency
|
|-
|TotalPrice
|decimal(19,2)
|Total price
|
|-
|TotalPriceInCurrency
|decimal(19,2)
|Total price in currency
|
|-
|DiscountPercent
|decimal(6,2)
|Discount percent
|
|-
|DiscountPrice
|decimal(18,2)
|Discount price
|
|-
|DiscountPriceInCurrency
|decimal(18,2)
|Discount price in currency
|
|-
|PurchasePriceAfterDiscount
|decimal(18,4)
|Purchase price after discount
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(18,4)
|Purchase price after discount in currency
|
|-
|TotalPriceAfterDiscount
|decimal(18,2)
|Total price after discount
|
|-
|TotalPriceAfterDiscountInCurrency
|decimal(18,2)
|Total price after discount in currency
|
|-
|PerPiecePurchasePrice
|decimal(18,6)
|Per piece purchase price
|
|-
|PerPieceVATPrice
|decimal(18,4)
|Per piece VAT price
|
|-
|TotalPriceWithVAT
|decimal(18,2)
|Total price with VAT
|
|-
|TotalPriceWithVATInCurrency
|decimal(18,2)
|Total price with VAT in currency
|
|-
|VATRate
|numeric(6,2)
|VAT rate
|
|-
|ExchangeRate
|decimal(19,4)
|Exchange rate
|
|-
|VATTypeID
|int
|VAT Type ID
| -1
|-
|VATSetted
|int
|VAT setted
| 0
|-
|VATSettedDate
|datetime
|VAT setted date
| null
|-
|Note
|nvarchar(100)
|Note
|
|-
|AvailableStockQuantity
|decimal(18,3)
|Available stock quantity
|
|-
|StockClosed
|int
|Stock closed
| 0
|-
|OriginItemID
|int
|ID of original items from document items list (see relation)
| API_GetDocumentItems.ID
|-
|ReturnID
|int
|
|
|-
|ReturnItemID
|int
|
|
|-
|ActionPrice
|int
|Action price
0 - normal price

1 - action price
|
|-
|Name2
|nvarchar(200)
|Name 2
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetDocumentItems]
</syntaxhighlight>

==== Notices ====
None.

API CreateDocumentItem

2021-09-30T14:13:52Z

Chrzaszcz:

==== Description ====
Method allows You to create new document item in system.

==== Exact name ====
<code>API_CreateDocumentItem</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ReceiptID
|int
|
|ID of delivery note from delivery note list (see relation)
| API_GetDeliveryNote.ID
|-
|@DocumentID
|int
|
|ID of invoices from invoices list (see relation)
| API_GetInvoices.ID
|-
|@DocumentID2
|int
|
|ID of original invoices from invoices list (see relation)
| API_GetInvoices.ID
|-
|@ProductID
|int
|
|ID of product from products list (see relation)
| API_GetProducts.ID
|-
|@StorageCardID
|int
|
|ID of stock dispositions from stock dispositions list (see relation)
| API_GetStockDispositions.ID
|-
|@MeasureUnitID
|int
|
|ID of unit from units list (see relation)
| API_GetUnits.ID
|-
|@VATID
|int
|
|ID of VAT rates from VAT rates list (see relation)
| API_GetVATRates.ID
|-
|@TypeID
|int
|
|Type ID.
1 - Product,

2 - Service,

7 - Text,

500 - CreditNote,

999 - Round
|
|-
|@IssueQuantity
|numeric(12,4)
|
|Issue quantity
|
|-
|@RetailPricePerPiece
|decimal(18,4)
|
|Retail price per piece
|
|-
|@PurchPrice
|decimal(19,4)
|
|Purch price
|
|-
|@PurchasePriceInCurrency
|decimal(19,4)
|
|Purchase price in currency
|
|-
|@TotalPrice
|decimal(19,2)
|
|Total price
|
|-
|@TotalPriceInCurrency
|decimal(19,2)
|
|Total price in currency
|
|-
|@DiscountPercent
|decimal(6,2)
|
|Discount percent
|
|-
|@DiscountPrice
|decimal(18,2)
|
|Discount price
|
|-
|@DiscountPriceInCurrency
|decimal(18,2)
|
|Discount price in currency
|
|-
|@PurchasePriceAfterDiscount
|decimal(18,4)
|
|Purchase price after discount
|
|-
|@PurchasePriceAfterDiscountInCurrency
|decimal(18,4)
|
|Purchase price after discount in currency
|
|-
|@TotalPriceAfterDiscount
|decimal(18,2)
|
|Total price after discount
|
|-
|@TotalPriceAfterDiscountInCurrency
|decimal(18,2)
|
|Total price after discount in currency
|
|-
|@PerPiecePurchasePrice
|decimal(18,6)
|
|Per piece purchase price
|
|-
|@PerPieceVATPrice
|decimal(18,4)
|
|Per piece VAT price
|
|-
|@TotalPriceWithVAT
|decimal(18,2)
|
|Total price with VAT
|
|-
|@TotalPriceWithVATInCurrency
|decimal(18,2)
|
|Total price with VAT in currency
|
|-
|@VATRate
|numeric(6,2)
|
|VAT rate
|
|-
|@ExchangeRate
|decimal(19,4)
|
|Exchange rate
|
|-
|@VATTypeID
|int
|
|VAT Type ID
| -1
|-
|@VATSetted
|int
|
|VAT setted
| 0
|-
|@VATSettedDate
|datetime
|
|VAT setted date
| null
|-
|@Note
|nvarchar(100)
|
|Note
|
|-
|@AvailableStockQuantity
|decimal(18,3)
|
|Available stock quantity
|
|-
|@StockClosed
|int
|
|Stock closed
| 0
|-
|@OriginItemID
|int
|
|ID of original items from document items list (see relation)
| API_GetDocumentItems.ID
|-
|@ReturnID
|int
|
|
|
|-
|@ReturnItemID
|int
|
|
|
|-
|@ActionPrice
|int
|
|Action price
0 - normal price

1 - action price
|
|-
|@Name2
|nvarchar(200)
|
|Name 2
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateDocumentItem] @ReceiptID= -1 ,@DocumentID= 7 ,@DocumentID2= -1 ,@ProductID= -1 ,@StorageCardID= -1 ,@MeasureUnitID= 148 ,@VATID= 16028 ,@TypeID= 7 ,@IssueQuantity= 1 ,@RetailPricePerPiece= 300 ,@PurchPrice= 300 ,@PurchasePriceInCurrency= 300 ,@TotalPrice= 300.00 ,@TotalPriceInCurrency= 300 ,@DiscountPercent= 10 ,@DiscountPrice= 30 ,@DiscountPriceInCurrency= 30 ,@PurchasePriceAfterDiscount= 270 ,@PurchasePriceAfterDiscountInCurrency= 270 ,@TotalPriceAfterDiscount= 270.00 ,@TotalPriceAfterDiscountInCurrency= 270 ,@PerPiecePurchasePrice= 0 ,@PerPieceVATPrice= 56.7 ,@TotalPriceWithVAT= 56.7 ,@TotalPriceWithVATInCurrency= 56.7 ,@VATRate= 21.00 ,@ExchangeRate= 1 ,@VATTypeID= 20 ,@VATSetted= 2 ,@VATSettedDate= NULL ,@Note= '' ,@AvailableStockQuantity= 0 ,@StockClosed= 0 ,@OriginItemID= -1 ,@ReturnID= NULL ,@ReturnItemID= NULL ,@ActionPrice= NULL ,@Name2= 'GDB400'
</syntaxhighlight>

==== Notices ====
None.

API UpdateDocumentItem

2021-09-30T14:11:51Z

Chrzaszcz:

==== Description ====
Method allows You to update document item in system.

==== Exact name ====
<code>API_UpdateDocumentItem</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetDocumentItems.ID
|-
|@ReceiptID
|int
|
|ID of delivery note from delivery note list (see relation)
| API_GetDeliveryNote.ID
|-
|@DocumentID
|int
|
|ID of invoices from invoices list (see relation)
| API_GetInvoices.ID
|-
|@DocumentID2
|int
|
|ID of original invoices from invoices list (see relation)
| API_GetInvoices.ID
|-
|@ProductID
|int
|
|ID of product from products list (see relation)
| API_GetProducts.ID
|-
|@Name2
|nvarchar(200)
|
|Name 2
|
|-
|@StorageCardID
|int
|
|ID of stock dispositions from stock dispositions list (see relation)
| API_GetStockDispositions.ID
|-
|@MeasureUnitID
|int
|
|ID of unit from units list (see relation)
| API_GetUnits.ID
|-
|@VATID
|int
|
|ID of VAT rates from VAT rates list (see relation)
| API_GetVATRates.ID
|-
|@TypeID
|int
|
|Type ID.
1 - Product,

2 - Service,

7 - Text,

500 - CreditNote,

999 - Round
|
|-
|@IssueQuantity
|numeric(12,4)
|
|Issue quantity
|
|-
|@RetailPricePerPiece
|decimal(18,4)
|
|Retail price per piece
|
|-
|@PurchPrice
|decimal(19,4)
|
|Purch price
|
|-
|@PurchasePriceInCurrency
|decimal(19,4)
|
|Purchase price in currency
|
|-
|@TotalPrice
|decimal(19,2)
|
|Total price
|
|-
|@TotalPriceInCurrency
|decimal(19,2)
|
|Total price in currency
|
|-
|@DiscountPercent
|decimal(6,2)
|
|Discount percent
|
|-
|@DiscountPrice
|decimal(18,2)
|
|Discount price
|
|-
|@DiscountPriceInCurrency
|decimal(18,2)
|
|Discount price in currency
|
|-
|@PurchasePriceAfterDiscount
|decimal(18,4)
|
|Purchase price after discount
|
|-
|@PurchasePriceAfterDiscountInCurrency
|decimal(18,4)
|
|Purchase price after discount in currency
|
|-
|@TotalPriceAfterDiscount
|decimal(18,2)
|
|Total price after discount
|
|-
|@TotalPriceAfterDiscountInCurrency
|decimal(18,2)
|
|Total price after discount in currency
|
|-
|@PerPiecePurchasePrice
|decimal(18,6)
|
|Per piece purchase price
|
|-
|@PerPieceVATPrice
|decimal(18,4)
|
|Per piece VAT price
|
|-
|@TotalPriceWithVAT
|decimal(18,2)
|
|Total price with VAT
|
|-
|@TotalPriceWithVATInCurrency
|decimal(18,2)
|
|Total price with VAT in currency
|
|-
|@VATRate
|numeric(6,2)
|
|VAT rate
|
|-
|@ExchangeRate
|decimal(19,4)
|
|Exchange rate
|
|-
|@VATTypeID
|int
|
|VAT Type ID
| -1
|-
|@VATSetted
|int
|
|VAT setted
| 0
|-
|@VATSettedDate
|datetime
|
|VAT setted date
| null
|-
|@Note
|nvarchar(100)
|
|Note
|
|-
|@AvailableStockQuantity
|decimal(18,3)
|
|Available stock quantity
|
|-
|@StockClosed
|int
|
|Stock closed
| 0
|-
|@OriginItemID
|int
|
|ID of original items from document items list (see relation)
| API_GetDocumentItems.ID
|-
|@ReturnID
|int
|
|
|
|-
|@ReturnItemID
|int
|
|
|
|-
|@ActionPrice
|int
|
|Action price
0 - normal price

1 - action price
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @ReceiptID int
DECLARE @DocumentID int
DECLARE @DocumentID2 int
DECLARE @ProductID int
DECLARE @Name2 nvarchar(200)
DECLARE @StorageCardID int
DECLARE @MeasureUnitID int
DECLARE @VATID int
DECLARE @TypeID int
DECLARE @IssueQuantity numeric(12,4)
DECLARE @RetailPricePerPiece decimal(18,4)
DECLARE @PurchPrice decimal(19,4)
DECLARE @PurchasePriceInCurrency decimal(19,4)
DECLARE @TotalPrice decimal(19,2)
DECLARE @TotalPriceInCurrency decimal(19,2)
DECLARE @DiscountPercent decimal(6,2)
DECLARE @DiscountPrice decimal(18,2)
DECLARE @DiscountPriceInCurrency decimal(18,2)
DECLARE @PurchasePriceAfterDiscount decimal(18,4)
DECLARE @PurchasePriceAfterDiscountInCurrency decimal(18,4)
DECLARE @TotalPriceAfterDiscount decimal(18,2)
DECLARE @TotalPriceAfterDiscountInCurrency decimal(18,2)
DECLARE @PerPiecePurchasePrice decimal(18,6)
DECLARE @PerPieceVATPrice decimal(18,4)
DECLARE @TotalPriceWithVAT decimal(18,2)
DECLARE @TotalPriceWithVATInCurrency decimal(18,2)
DECLARE @VATRate numeric(6,2)
DECLARE @ExchangeRate decimal(19,4)
DECLARE @VATTypeID int
DECLARE @VATSetted int
DECLARE @VATSettedDate datetime
DECLARE @Note nvarchar(100)
DECLARE @AvailableStockQuantity decimal(18,3)
DECLARE @StockClosed int
DECLARE @OriginItemID int
DECLARE @ReturnID int
DECLARE @ReturnItemID int
DECLARE @ActionPrice int

SELECT @ID = [ID],
@ReceiptID = [ReceiptID],
@DocumentID = [DocumentID],
@DocumentID2 = [DocumentID2],
@ProductID = [ProductID],
@Name2 = 'Name X',
@StorageCardID = [StorageCardID],
@MeasureUnitID = [MeasureUnitID],
@VATID = [VATID],
@TypeID = [TypeID],
@IssueQuantity = [IssueQuantity],
@RetailPricePerPiece = [RetailPricePerPiece],
@PurchPrice = [PurchPrice],
@PurchasePriceInCurrency = [PurchasePriceInCurrency],
@TotalPrice = [TotalPrice],
@TotalPriceInCurrency = [TotalPriceInCurrency],
@DiscountPercent = [DiscountPercent],
@DiscountPrice = [DiscountPrice],
@DiscountPriceInCurrency = [DiscountPriceInCurrency],
@PurchasePriceAfterDiscount = [PurchasePriceAfterDiscount],
@PurchasePriceAfterDiscountInCurrency = [PurchasePriceAfterDiscountInCurrency],
@TotalPriceAfterDiscount = [TotalPriceAfterDiscount],
@TotalPriceAfterDiscountInCurrency = [TotalPriceAfterDiscountInCurrency],
@PerPiecePurchasePrice = [PerPiecePurchasePrice],
@PerPieceVATPrice = [PerPieceVATPrice],
@TotalPriceWithVAT = [TotalPriceWithVAT],
@TotalPriceWithVATInCurrency = [TotalPriceWithVATInCurrency],
@VATRate = [VATRate],
@ExchangeRate = [ExchangeRate],
@VATTypeID = [VATTypeID],
@VATSetted = [VATSetted],
@VATSettedDate = [VATSettedDate],
@Note = [Note],
@AvailableStockQuantity = [AvailableStockQuantity],
@StockClosed = [StockClosed],
@OriginItemID = [OriginItemID],
@ReturnID = [ReturnID],
@ReturnItemID = [ReturnItemID],
@ActionPrice = [ActionPrice],
FROM [API_GetDocumentItems]
WHERE id = 3

EXECUTE @return_value = [API_UpdateDocumentItem]
@ID,
@ReceiptID,
@DocumentID,
@DocumentID2,
@ProductID,
@Name2,
@StorageCardID,
@MeasureUnitID,
@VATID,
@TypeID,
@IssueQuantity,
@RetailPricePerPiece,
@PurchPrice,
@PurchasePriceInCurrency,
@TotalPrice,
@TotalPriceInCurrency,
@DiscountPercent,
@DiscountPrice,
@DiscountPriceInCurrency,
@PurchasePriceAfterDiscount,
@PurchasePriceAfterDiscountInCurrency,
@TotalPriceAfterDiscount,
@TotalPriceAfterDiscountInCurrency,
@PerPiecePurchasePrice,
@PerPieceVATPrice,
@TotalPriceWithVAT,
@TotalPriceWithVATInCurrency,
@VATRate,
@ExchangeRate,
@VATTypeID,
@VATSetted,
@VATSettedDate,
@Note,
@AvailableStockQuantity,
@StockClosed,
@OriginItemID,
@ReturnID,
@ReturnItemID,
@ActionPrice
</syntaxhighlight>

==== Notices ====
None.

API RemoveOrderItem

2021-09-06T11:18:45Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to remove order item in system. ==== Exact name ==== <code>API_RemoveOrderItem</code> ==== Type ==== Standard exe…“

==== Description ====
Method allows You to remove order item in system.

==== Exact name ====
<code>API_RemoveOrderItem</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetOrderDetail.ID
|}

==== Return ====
0 : OK
100 : Item does not exist
200 : Item ordered from the supplier

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_RemoveOrderItem]
@ID = 3
</syntaxhighlight>

==== Notices ====
None.

API EN DATA METHOD DESC

2021-09-06T11:16:08Z

Chrzaszcz:

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_CreateOrder]]
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[API_UpdateOrdersDetail]]
* [[Send Order]]
* [[API_RemoveOrderItem]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroups_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

===== Item supplier operations =====
* [[API_GetSupplierProductCrossList]]
* [[API_RemoveAllSupplierProductDoubleCrosses]]
* [[API_GetSupplierProductPriceList]]
* [[API_RemoveAllSupplierProductPriceWithoutSupplierProductCrossListConnection]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

==== Image ====
* [[API_GetImage]]
* [[API_CreateImage]]
* [[API_UpdateImage]]
* [[API_RemoveImage]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API RemoveAllSupplierProductDoubleCrosses

2021-07-29T10:43:07Z

Chrzaszcz:

==== Description ====
Method allows You to remove all supplier product double crosses in system. The method leaves the last uploaded cross in system

==== Exact name ====
<code>API_RemoveAllSupplierProductDoubleCrosses</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@SupplierID
|int
|
|Internal system id
|API_GetCustomers.ID
|}

==== Return ====
0 : OK
100 : Item does not exist

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_RemoveAllSupplierProductDoubleCrosses]
@SupplierID = 3
</syntaxhighlight>

==== Notices ====
None.

API GetSupplierProductPriceList

2021-07-29T10:18:27Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method gives You overview of existing supplier product price list in system. ==== Exact name ==== <code>API_GetSupplierProductPriceL…“

==== Description ====
Method gives You overview of existing supplier product price list in system.

==== Exact name ====
<code>API_GetSupplierProductPriceList</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|SupplierID
|int
|SupplierID
|API_GetCustomers.ID
|-
|SupplierProductCode
|nvarchar(40)
|Supplier product code
|API_GetSupplierProductCrossList.SupplierProductCode
|-
|ManufacturerSupplier
|nvarchar(50)
|Manufacturer supplier
|API_GetSupplierProductCrossList.ManufacturerSupplier
|-
|Prefix
|nvarchar(3)
|Prefix
|API_GetSupplierProductCrossList.Prefix
|-
|ForeignPrice
|decimal(19,6)
|Foreign price
|
|-
|CreatedDate
|datetime
|Created date
|
|-
|UpdatedDate
|datetime
|Updated date
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetSupplierProductPriceList]
</syntaxhighlight>

==== Notices ====
None.

API GetSupplierProductCrossList

2021-07-29T10:11:51Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method gives You overview of existing supplier product cross list in system. ==== Exact name ==== <code>API_GetSupplierProductCrossL…“

==== Description ====
Method gives You overview of existing supplier product cross list in system.

==== Exact name ====
<code>API_GetSupplierProductCrossList</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|GroupID
|int
|
|API_GetProductGroups.ID
|-
|SupplierID
|int
|SupplierID
|API_GetCustomers.ID
|-
|SupplierItemName
|nvarchar(150)
|Supplier item name
|
|-
|SupplierProductCode
|nvarchar(40)
|Supplier product code
|
|-
|Prefix
|nvarchar(3)
|Prefix
|
|-
|ManufacturerSupplier
|nvarchar(50)
|Manufacturer supplier
|
|-
|CreatedDate
|datetime
|Created date
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetSupplierProductCrossList]
</syntaxhighlight>

==== Notices ====
None.

API RemoveAllSupplierProductPriceWithoutSupplierProductCrossListConnection

2021-07-29T09:54:20Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to remove all supplier product price without supplier product cross list connection in system. ==== Exact name ===…“

==== Description ====
Method allows You to remove all supplier product price without supplier product cross list connection in system.

==== Exact name ====
<code>API_RemoveAllSupplierProductPriceWithoutSupplierProductCrossListConnection</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@SupplierID
|int
|
|Internal system id
|API_GetCustomers.ID
|}

==== Return ====
0 : OK
100 : Item does not exist

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_RemoveAllSupplierProductPriceWithoutSupplierProductCrossListConnection]
@SupplierID = 3
</syntaxhighlight>

==== Notices ====
None.

API RemoveAllSupplierProductDoubleCrosses

2021-07-29T09:50:46Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to remove all supplier product double crosses in system. ==== Exact name ==== <code>API_RemoveAllSupplierProductDo…“

==== Description ====
Method allows You to remove all supplier product double crosses in system.

==== Exact name ====
<code>API_RemoveAllSupplierProductDoubleCrosses</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@SupplierID
|int
|
|Internal system id
|API_GetCustomers.ID
|}

==== Return ====
0 : OK
100 : Item does not exist

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_RemoveAllSupplierProductDoubleCrosses]
@SupplierID = 3
</syntaxhighlight>

==== Notices ====
None.

API EN DATA METHOD DESC

2021-07-29T09:44:43Z

Chrzaszcz:

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_CreateOrder]]
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[API_UpdateOrdersDetail]]
* [[Send Order]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroups_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

===== Item supplier operations =====
* [[API_GetSupplierProductCrossList]]
* [[API_RemoveAllSupplierProductDoubleCrosses]]
* [[API_GetSupplierProductPriceList]]
* [[API_RemoveAllSupplierProductPriceWithoutSupplierProductCrossListConnection]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

==== Image ====
* [[API_GetImage]]
* [[API_CreateImage]]
* [[API_UpdateImage]]
* [[API_RemoveImage]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API GetOrders

2021-05-28T11:14:13Z

Chrzaszcz:

==== Description ====
Method gives You overview of existing orders in system.

==== Exact name ====
<code>API_GetOrders</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|TypeID
|int
|Type ID.

-1 - _NA

1 - Orderer

2 - Supplier
|
|-
|CustomerID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|OrdererID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|RecipientID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|BranchID
|int
|ID of branch from branch list (see relation)
|API_GetBranches.ID
|-
|TransportID
|int
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|CurrencyID
|int
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|PaymentFormID
|int
|Payment form ID.

-1 - _NA

1 - Cash

2 - WireTransfer

3 - CreditCard

4 - Before

5 - Voucher

6 - CashOnDelivery

7 - GoPay

8 - Payout

9 - Przelewy24

10 - Klarna

11 - Stripe

12 - PayPal

13 - Baselinker
|
|-
|ExchangeRate
|decimal(18,6)
|Exchange rate
|
|-
|OrderNumber
|nvarchar(25)
|Order number
|
|-
|ForeignOrderNumber
|nvarchar(80)
|Foreign order number
|
|-
|Date
|datetime
|Date
|
|-
|SendDate
|datetime
|Send date
|
|-
|Term
|datetime
|Term
|
|-
|Note
|nvarchar(600)
|Note
|
|-
|CurrencyInCurrencyID
|int
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|StockID
|int
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|SupplierName
|nvarchar(140)
|Supplier name
|
|-
|SupplerStreet
|nvarchar(100)
|Suppler street
|
|-
|SupplierCIty
|nvarchar(140)
|Supplier cIty
|
|-
|SupplierZIPCode
|char(10)
|Supplier ZIP code
|
|-
|SupplierCountry
|nvarchar(50)
|Supplier country
|
|-
|SupplierRegion
|nvarchar(30)
|Supplier region
|
|-
|SupplierState
|nvarchar(50)
|Supplier state
|
|-
|SupplierCompanyRegistrationNumber
|char(20)
|Supplier company registration number
|
|-
|SupplierVATNumber
|char(20)
|Supplier VAT number
|
|-
|SupplierPhone
|nvarchar(30)
|Supplier phone
|
|-
|SupplierFax
|nvarchar(30)
|Supplier fax
|
|-
|SupplierMobilePhone
|nvarchar(30)
|Supplier mobile phone
|
|-
|SupplierEmail
|nvarchar(60)
|Supplier email
|
|-
|SupplierWeb
|nvarchar(50)
|Supplier web
|
|-
|SupplierBankName
|nvarchar(120)
|Supplier bank name
|
|-
|SupplierBankAccount
|nvarchar(50)
|Supplier bank account
|
|-
|OrdererName
|nvarchar(140)
|Orderer name
|
|-
|OrdererStreet
|nvarchar(100)
|Orderer street
|
|-
|OrdererCity
|nvarchar(140)
|Orderer city
|
|-
|OrdererZIPCode
|char(10)
|Orderer ZIP code
|
|-
|OrdererCountry
|nvarchar(50)
|Orderer country
|
|-
|OrdererRegion
|nvarchar(30)
|Orderer region
|
|-
|OrdererState
|nvarchar(50)
|Orderer state
|
|-
|OrdererCompanyRegistrationNumber
|char(20)
|Orderer company registration number
|
|-
|OrdererVATNumber
|char(20)
|Orderer VAT number
|
|-
|OrdererVATNumber2
|char(20)
|Orderer VAT number 2
|
|-
|OrdererPhone
|nvarchar(30)
|Orderer phone
|
|-
|OrdererFax
|nvarchar(30)
|Orderer fax
|
|-
|OrdererMobilePhone
|nvarchar(30)
|Orderer mobile phone
|
|-
|OrdererEmail
|nvarchar(60)
|Orderer email
|
|-
|OrdererWeb
|nvarchar(50)
|Orderer web
|
|-
|OrdererBankName
|nvarchar(120)
|Orderer bank name
|
|-
|OrdererBankAccount
|nvarchar(50)
|Orderer bank account
|
|-
|RecipientName
|nvarchar(140)
|Recipient name
|
|-
|RecipientStreet
|nvarchar(100)
|Recipient street
|
|-
|RecipientCity
|nvarchar(140)
|Recipient city
|
|-
|RecipientZIPCode
|char(10)
|Recipient ZIP code
|
|-
|RecipientCountry
|nvarchar(50)
|Recipient country
|
|-
|RecipientRegion
|nvarchar(30)
|Recipient region
|
|-
|RecipientState
|nvarchar(50)
|Recipient state
|
|-
|RecipientCompanyRegistrationNumber
|char(20)
|Recipient company registration number
|
|-
|RecipientVATNumber
|char(20)
|Recipient VAT number
|
|-
|RecipientPhone
|nvarchar(30)
|Recipient phone
|
|-
|RecipientFax
|nvarchar(30)
|Recipient fax
|
|-
|RecipientMobilePhone
|nvarchar(30)
|Recipient mobile phone
|
|-
|RecipientEmail
|nvarchar(60)
|Recipient email
|
|-
|RecipientWeb
|nvarchar(50)
|Recipient web
|
|-
|RecipientBankName
|nvarchar(120)
|Recipient bank name
|
|-
|RecipientBankAccount
|nvarchar(50)
|Recipient bank account
|
|-
|SupplierVATNumber2
|char(20)
|Supplier VAT number 2
|
|-
|PaymentGatewayState
|int
|Payment gateway state

-1 - _NA

0 - Created

1 - PaymentMethodChosen

2 - Paid

3 - Authorized

4 - Canceled

5 - Timeouted

6 - Refunded

7 - PartiallyRefunded

|
|-
|PaymentGatewayReceivedDate
|datetime
|Payment gateway received date
|
|-
|SubtransportID
|int
|Subtransport ID
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetOrders]
</syntaxhighlight>

==== Notices ====
None.

API GetOrders

2021-05-28T11:13:39Z

Chrzaszcz:

==== Description ====
Method gives You overview of existing orders in system.

==== Exact name ====
<code>API_GetOrders</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|TypeID
|int
|Type ID.

-1 - _NA

1 - Orderer

2 - Supplier
|
|-
|CustomerID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|OrdererID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|RecipientID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|BranchID
|int
|ID of branch from branch list (see relation)
|API_GetBranches.ID
|-
|TransportID
|int
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|CurrencyID
|int
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|PaymentFormID
|int
|Payment form ID.

-1 - _NA

1 - Cash

2 - WireTransfer

3 - CreditCard

4 - Before

5 - Voucher

6 - CashOnDelivery
7 - GoPay
8 - Payout
9 - Przelewy24
10 - Klarna
11 - Stripe
12 - PayPal
13 - Baselinker
|
|-
|ExchangeRate
|decimal(18,6)
|Exchange rate
|
|-
|OrderNumber
|nvarchar(25)
|Order number
|
|-
|ForeignOrderNumber
|nvarchar(80)
|Foreign order number
|
|-
|Date
|datetime
|Date
|
|-
|SendDate
|datetime
|Send date
|
|-
|Term
|datetime
|Term
|
|-
|Note
|nvarchar(600)
|Note
|
|-
|CurrencyInCurrencyID
|int
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|StockID
|int
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|SupplierName
|nvarchar(140)
|Supplier name
|
|-
|SupplerStreet
|nvarchar(100)
|Suppler street
|
|-
|SupplierCIty
|nvarchar(140)
|Supplier cIty
|
|-
|SupplierZIPCode
|char(10)
|Supplier ZIP code
|
|-
|SupplierCountry
|nvarchar(50)
|Supplier country
|
|-
|SupplierRegion
|nvarchar(30)
|Supplier region
|
|-
|SupplierState
|nvarchar(50)
|Supplier state
|
|-
|SupplierCompanyRegistrationNumber
|char(20)
|Supplier company registration number
|
|-
|SupplierVATNumber
|char(20)
|Supplier VAT number
|
|-
|SupplierPhone
|nvarchar(30)
|Supplier phone
|
|-
|SupplierFax
|nvarchar(30)
|Supplier fax
|
|-
|SupplierMobilePhone
|nvarchar(30)
|Supplier mobile phone
|
|-
|SupplierEmail
|nvarchar(60)
|Supplier email
|
|-
|SupplierWeb
|nvarchar(50)
|Supplier web
|
|-
|SupplierBankName
|nvarchar(120)
|Supplier bank name
|
|-
|SupplierBankAccount
|nvarchar(50)
|Supplier bank account
|
|-
|OrdererName
|nvarchar(140)
|Orderer name
|
|-
|OrdererStreet
|nvarchar(100)
|Orderer street
|
|-
|OrdererCity
|nvarchar(140)
|Orderer city
|
|-
|OrdererZIPCode
|char(10)
|Orderer ZIP code
|
|-
|OrdererCountry
|nvarchar(50)
|Orderer country
|
|-
|OrdererRegion
|nvarchar(30)
|Orderer region
|
|-
|OrdererState
|nvarchar(50)
|Orderer state
|
|-
|OrdererCompanyRegistrationNumber
|char(20)
|Orderer company registration number
|
|-
|OrdererVATNumber
|char(20)
|Orderer VAT number
|
|-
|OrdererVATNumber2
|char(20)
|Orderer VAT number 2
|
|-
|OrdererPhone
|nvarchar(30)
|Orderer phone
|
|-
|OrdererFax
|nvarchar(30)
|Orderer fax
|
|-
|OrdererMobilePhone
|nvarchar(30)
|Orderer mobile phone
|
|-
|OrdererEmail
|nvarchar(60)
|Orderer email
|
|-
|OrdererWeb
|nvarchar(50)
|Orderer web
|
|-
|OrdererBankName
|nvarchar(120)
|Orderer bank name
|
|-
|OrdererBankAccount
|nvarchar(50)
|Orderer bank account
|
|-
|RecipientName
|nvarchar(140)
|Recipient name
|
|-
|RecipientStreet
|nvarchar(100)
|Recipient street
|
|-
|RecipientCity
|nvarchar(140)
|Recipient city
|
|-
|RecipientZIPCode
|char(10)
|Recipient ZIP code
|
|-
|RecipientCountry
|nvarchar(50)
|Recipient country
|
|-
|RecipientRegion
|nvarchar(30)
|Recipient region
|
|-
|RecipientState
|nvarchar(50)
|Recipient state
|
|-
|RecipientCompanyRegistrationNumber
|char(20)
|Recipient company registration number
|
|-
|RecipientVATNumber
|char(20)
|Recipient VAT number
|
|-
|RecipientPhone
|nvarchar(30)
|Recipient phone
|
|-
|RecipientFax
|nvarchar(30)
|Recipient fax
|
|-
|RecipientMobilePhone
|nvarchar(30)
|Recipient mobile phone
|
|-
|RecipientEmail
|nvarchar(60)
|Recipient email
|
|-
|RecipientWeb
|nvarchar(50)
|Recipient web
|
|-
|RecipientBankName
|nvarchar(120)
|Recipient bank name
|
|-
|RecipientBankAccount
|nvarchar(50)
|Recipient bank account
|
|-
|SupplierVATNumber2
|char(20)
|Supplier VAT number 2
|
|-
|PaymentGatewayState
|int
|Payment gateway state

-1 - _NA

0 - Created

1 - PaymentMethodChosen

2 - Paid

3 - Authorized

4 - Canceled

5 - Timeouted

6 - Refunded

7 - PartiallyRefunded

|
|-
|PaymentGatewayReceivedDate
|datetime
|Payment gateway received date
|
|-
|SubtransportID
|int
|Subtransport ID
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetOrders]
</syntaxhighlight>

==== Notices ====
None.

API UpdateOrdersDetail

2021-05-28T10:44:26Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to update order detail in system. ==== Exact name ==== <code>API_UpdateOrdersDetail</code> ==== Type ==== Standar…“

==== Description ====
Method allows You to update order detail in system.

==== Exact name ====
<code>API_UpdateOrdersDetail</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetOrderDetail.ID
|-
|@DeliveredQuantity
|decimal(18,4)
|
|Delivered quantity
|
|-
|@CanceledQuantity
|decimal(18,4)
|
|Canceled quantity
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @DeliveredQuantity decimal(18,4)
DECLARE @CanceledQuantity decimal(18,4)

set @ID = 15
set @DeliveredQuantity = 0
set @CanceledQuantity = 3

EXECUTE @return_value = [API_UpdateOrdersDetail]
@ID
,@DeliveredQuantity
,@CanceledQuantity

</syntaxhighlight>

==== Notices ====
None.

API EN DATA METHOD DESC

2021-05-28T10:40:07Z

Chrzaszcz: /* Orders */

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_CreateOrder]]
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[API_UpdateOrdersDetail]]
* [[Send Order]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroups_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

==== Image ====
* [[API_GetImage]]
* [[API_CreateImage]]
* [[API_UpdateImage]]
* [[API_RemoveImage]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API GetOrders

2021-05-27T13:40:03Z

Chrzaszcz:

==== Description ====
Method gives You overview of existing orders in system.

==== Exact name ====
<code>API_GetOrders</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|TypeID
|int
|Type ID.

-1 - _NA

1 - Orderer

2 - Supplier
|
|-
|CustomerID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|OrdererID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|RecipientID
|int
|ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|BranchID
|int
|ID of branch from branch list (see relation)
|API_GetBranches.ID
|-
|TransportID
|int
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|CurrencyID
|int
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|PaymentFormID
|int
|Payment form ID.

-1 - _NA

1 - Cash

2 - WireTransfer

3 - CreditCard

4 - Before

5 - Voucher

6 - CashOnDelivery
|
|-
|ExchangeRate
|decimal(18,6)
|Exchange rate
|
|-
|OrderNumber
|nvarchar(25)
|Order number
|
|-
|ForeignOrderNumber
|nvarchar(80)
|Foreign order number
|
|-
|Date
|datetime
|Date
|
|-
|SendDate
|datetime
|Send date
|
|-
|Term
|datetime
|Term
|
|-
|Note
|nvarchar(600)
|Note
|
|-
|CurrencyInCurrencyID
|int
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|StockID
|int
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|SupplierName
|nvarchar(140)
|Supplier name
|
|-
|SupplerStreet
|nvarchar(100)
|Suppler street
|
|-
|SupplierCIty
|nvarchar(140)
|Supplier cIty
|
|-
|SupplierZIPCode
|char(10)
|Supplier ZIP code
|
|-
|SupplierCountry
|nvarchar(50)
|Supplier country
|
|-
|SupplierRegion
|nvarchar(30)
|Supplier region
|
|-
|SupplierState
|nvarchar(50)
|Supplier state
|
|-
|SupplierCompanyRegistrationNumber
|char(20)
|Supplier company registration number
|
|-
|SupplierVATNumber
|char(20)
|Supplier VAT number
|
|-
|SupplierPhone
|nvarchar(30)
|Supplier phone
|
|-
|SupplierFax
|nvarchar(30)
|Supplier fax
|
|-
|SupplierMobilePhone
|nvarchar(30)
|Supplier mobile phone
|
|-
|SupplierEmail
|nvarchar(60)
|Supplier email
|
|-
|SupplierWeb
|nvarchar(50)
|Supplier web
|
|-
|SupplierBankName
|nvarchar(120)
|Supplier bank name
|
|-
|SupplierBankAccount
|nvarchar(50)
|Supplier bank account
|
|-
|OrdererName
|nvarchar(140)
|Orderer name
|
|-
|OrdererStreet
|nvarchar(100)
|Orderer street
|
|-
|OrdererCity
|nvarchar(140)
|Orderer city
|
|-
|OrdererZIPCode
|char(10)
|Orderer ZIP code
|
|-
|OrdererCountry
|nvarchar(50)
|Orderer country
|
|-
|OrdererRegion
|nvarchar(30)
|Orderer region
|
|-
|OrdererState
|nvarchar(50)
|Orderer state
|
|-
|OrdererCompanyRegistrationNumber
|char(20)
|Orderer company registration number
|
|-
|OrdererVATNumber
|char(20)
|Orderer VAT number
|
|-
|OrdererVATNumber2
|char(20)
|Orderer VAT number 2
|
|-
|OrdererPhone
|nvarchar(30)
|Orderer phone
|
|-
|OrdererFax
|nvarchar(30)
|Orderer fax
|
|-
|OrdererMobilePhone
|nvarchar(30)
|Orderer mobile phone
|
|-
|OrdererEmail
|nvarchar(60)
|Orderer email
|
|-
|OrdererWeb
|nvarchar(50)
|Orderer web
|
|-
|OrdererBankName
|nvarchar(120)
|Orderer bank name
|
|-
|OrdererBankAccount
|nvarchar(50)
|Orderer bank account
|
|-
|RecipientName
|nvarchar(140)
|Recipient name
|
|-
|RecipientStreet
|nvarchar(100)
|Recipient street
|
|-
|RecipientCity
|nvarchar(140)
|Recipient city
|
|-
|RecipientZIPCode
|char(10)
|Recipient ZIP code
|
|-
|RecipientCountry
|nvarchar(50)
|Recipient country
|
|-
|RecipientRegion
|nvarchar(30)
|Recipient region
|
|-
|RecipientState
|nvarchar(50)
|Recipient state
|
|-
|RecipientCompanyRegistrationNumber
|char(20)
|Recipient company registration number
|
|-
|RecipientVATNumber
|char(20)
|Recipient VAT number
|
|-
|RecipientPhone
|nvarchar(30)
|Recipient phone
|
|-
|RecipientFax
|nvarchar(30)
|Recipient fax
|
|-
|RecipientMobilePhone
|nvarchar(30)
|Recipient mobile phone
|
|-
|RecipientEmail
|nvarchar(60)
|Recipient email
|
|-
|RecipientWeb
|nvarchar(50)
|Recipient web
|
|-
|RecipientBankName
|nvarchar(120)
|Recipient bank name
|
|-
|RecipientBankAccount
|nvarchar(50)
|Recipient bank account
|
|-
|SupplierVATNumber2
|char(20)
|Supplier VAT number 2
|
|-
|PaymentGatewayState
|int
|Payment gateway state

-1 - _NA

0 - Created

1 - PaymentMethodChosen

2 - Paid

3 - Authorized

4 - Canceled

5 - Timeouted

6 - Refunded

7 - PartiallyRefunded

|
|-
|PaymentGatewayReceivedDate
|datetime
|Payment gateway received date
|
|-
|SubtransportID
|int
|Subtransport ID
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetOrders]
</syntaxhighlight>

==== Notices ====
None.

API UpdateOrders

2021-05-13T11:16:52Z

Chrzaszcz:

==== Description ====
Method allows You to update order in system.

==== Exact name ====
<code>API_UpdateOrders</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetOrders.ID
|-
|@ForeignOrderNumber
|nvarchar(80)
|
|Foreign order number
|
|-
|@SendDate
|datetime
|
|Send date
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @ForeignOrderNumber nvarchar(80)
DECLARE @SendDate datetime

set @ID = 15
set @ForeignOrderNumber = 'OR123456'
set @SendDate = GETDATE()

EXECUTE @return_value = [API_UpdateOrders]
@ID
,@ForeignOrderNumber
,@SendDate

</syntaxhighlight>

==== Notices ====
None.

API RemoveImage

2021-04-06T12:46:47Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to remove image in system. ==== Exact name ==== <code>API_RemoveImage</code> ==== Type ==== Standard executable s…“

==== Description ====
Method allows You to remove image in system.

==== Exact name ====
<code>API_RemoveImage</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetImage.ID
|}

==== Return ====
0 : OK
100 : Item does not exist

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_RemoveImage]
@ID = 3
</syntaxhighlight>

==== Notices ====
None.

API UpdateImage

2021-04-06T12:43:33Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to update image in system. ==== Exact name ==== <code>API_UpdateImage</code> ==== Type ==== Standard executable s…“

==== Description ====
Method allows You to update image in system.

==== Exact name ====
<code>API_UpdateImage</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|
|-
|@ProduktGroupID
|int
|
|Produkt group ID
|API_GetProductGroups.ID
|-
|@Sorting
|int
|
|Sorting, numbers from 0 up
|
|-
|@ImageURL
|nvarchar(260)
|
|Image URL
|
|-
|@IsFeedImage
|int
|
|Is feed image
NO=0; YES=1
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @ProduktGroupID int
DECLARE @Sorting int
DECLARE @ImageURL nvarchar(260)
DECLARE @IsFeedImage int

SELECT @ID = [ID],
@ProduktGroupID = [ProduktGroupID],
@Sorting = [Sorting],
@ImageURL = [ImageURL],
@IsFeedImage = 1
FROM [API_GetImage]
WHERE id = 2345

EXECUTE @return_value = [API_UpdateImage]
@ID,
@ProduktGroupID,
@Sorting,
@ImageURL,
@IsFeedImage

</syntaxhighlight>

==== Notices ====
None.

API CreateImage

2021-04-06T12:34:23Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to create new image in system. ==== Exact name ==== <code>API_CreateImage</code> ==== Type ==== Standard executab…“

==== Description ====
Method allows You to create new image in system.

==== Exact name ====
<code>API_CreateImage</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ProduktGroupID
|int
|
|Produkt group ID
|API_GetProductGroups.ID
|-
|@Sorting
|int
|
|Sorting, numbers from 0 up
|
|-
|@ImageURL
|int
|
|Image URL
|
|-
|@IsFeedImage
|int
|
|Is feed image
NO=0; YES=1
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateImage] @ProduktGroupID = 2345, @Sorting = 1, @ImageURL = 'https://www.nextis.cz/wp-content/uploads/2018/10/logo_nextis01.png', @IsFeedImage = 0
</syntaxhighlight>

==== Notices ====
None.

API GetImage

2021-04-06T11:14:53Z

Chrzaszcz:

====Description====
Method gives You overview of existing image in system.
====Exact name====
<code>API_GetImage</code>
====Type====
Standard view.
====Specification====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|ProduktGroupID
|int
|Produkt group ID
|API_GetProductGroups.ID
|-
|Sorting
|int
|Sorting, numbers from 0 up
|
|-
|ImageURL
|nvarchar(260)
|Image URL
|
|-
|IsFeedImage
|int
|Is feed image
NO=0; YES=1
|
|}
====Example====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetImage]
</syntaxhighlight>
====Notices ====
None.

API GetImage

2021-04-06T11:13:14Z

Chrzaszcz: Založena nová stránka s textem „====Description==== Method gives You overview of existing image in system. ====Exact name==== <code>API_GetImage</code> ====Type==== Standard view. ====Spe…“

====Description====
Method gives You overview of existing image in system.
====Exact name====
<code>API_GetImage</code>
====Type====
Standard view.
====Specification====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|ProduktGroupID
|int
|Produkt group ID
|
|-
|Sorting
|int
|Sorting, numbers from 0 up
|
|-
|ImageURL
|nvarchar(260)
|Image URL
|
|-
|IsFeedImage
|int
|Is feed image
NO=0; YES=1
|
|}
====Example====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetImage]
</syntaxhighlight>
====Notices ====
None.

API EN DATA METHOD DESC

2021-04-06T11:05:33Z

Chrzaszcz:

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_CreateOrder]]
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[Send Order]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroups_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

==== Image ====
* [[API_GetImage]]
* [[API_CreateImage]]
* [[API_UpdateImage]]
* [[API_RemoveImage]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API CreateOrder

2020-11-06T15:20:54Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - Entire only
|
|-
|@LockRelease
|int
|
|Pause warehouse release (manually authorization required)
0 - OFF
1 - ON
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OtherShippingAddress
|bit
|
|Other shipping address
0 - NO
1 - YES
|
|-
|@RecipientName
|nvarchar(140)
|
|Recipient name
|
|-
|@RecipientStreet
|nvarchar(100)
|
|Recipient street
|
|-
|@RecipientCity
|nvarchar(140)
|
|Recipient city
|
|-
|@RecipientPostal
|nvarchar(10)
|
|Recipient postal
|
|-
|@RecipientDistrict
|nvarchar(150)
|
|Recipient district
|
|-
|@RecipientProvince
|nvarchar(30)
|
|Recipient province
|
|-
|@RecipientStat
|nvarchar(50)
|
|Recipient stat
|
|-
|@RecipientRegNo
|nvarchar(20)
|
|Recipient Reg. No.
|
|-
|@RecipientTAX
|nvarchar(20)
|
|Recipient TAX
|
|-
|@RecipientTelephone
|nvarchar(30)
|
|Recipient telephone
|
|-
|@RecipientFax
|nvarchar(30)
|
|Recipient fax
|
|-
|@RecipientPhone
|nvarchar(30)
|
|Recipient phone
|
|-
|@RecipientEmail
|nvarchar(60)
|
|Recipient email
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
-1 - Automatic selection
|API_GetCustomers.ID
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union all
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OtherShippingAddress = 1,
@RecipientName = 'Test Name',
@RecipientStreet = 'Street',
@RecipientCity = 'City',
@RecipientPostal = '00-320',
@RecipientDistrict = '',
@RecipientProvince = '',
@RecipientStat = 'Polska',
@RecipientRegNo = '',
@RecipientTAX = '',
@RecipientTelephone = '',
@RecipientFax = '',
@RecipientPhone = '123-456-789',
@RecipientEmail = '',
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-11-06T15:15:29Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - Entire only
|
|-
|@LockRelease
|int
|
|Pause warehouse release (manually authorization required)
0 - OFF
1 - ON
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OtherShippingAddress
|
|
|
|
|-
|@RecipientName
|
|
|
|
|-
|@RecipientStreet
|
|
|
|
|-
|@RecipientCity
|
|
|
|
|-
|@RecipientPostal
|
|
|
|
|-
|@RecipientDistrict
|
|
|
|
|-
|@RecipientProvince
|
|
|
|
|-
|@RecipientStat
|
|
|
|
|-
|@RecipientRegNo
|
|
|
|
|-
|@RecipientTAX
|
|
|
|
|-
|@RecipientTelephone
|
|
|
|
|-
|@RecipientFax
|
|
|
|
|-
|@RecipientPhone
|
|
|
|
|-
|@RecipientEmail
|
|
|
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
-1 - Automatic selection
|API_GetCustomers.ID
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union all
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OtherShippingAddress = 1,
@RecipientName = 'Test Name',
@RecipientStreet = 'Street',
@RecipientCity = 'City',
@RecipientPostal = '00-320',
@RecipientDistrict = '',
@RecipientProvince = '',
@RecipientStat = 'Polska',
@RecipientRegNo = '',
@RecipientTAX = '',
@RecipientTelephone = '',
@RecipientFax = '',
@RecipientPhone = '123-456-789',
@RecipientEmail = '',
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-11-06T15:12:14Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - Entire only
|
|-
|@LockRelease
|int
|
|Pause warehouse release (manually authorization required)
0 - OFF
1 - ON
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
-1 - Automatic selection
|API_GetCustomers.ID
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union all
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OtherShippingAddress = 1,
@RecipientName = 'Test Name',
@RecipientStreet = 'Street',
@RecipientCity = 'City',
@RecipientPostal = '00-320',
@RecipientDistrict = '',
@RecipientProvince = '',
@RecipientStat = 'Polska',
@RecipientRegNo = '',
@RecipientTAX = '',
@RecipientTelephone = '',
@RecipientFax = '',
@RecipientPhone = '123-456-789',
@RecipientEmail = '',
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-09-29T10:03:13Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - Entire only
|
|-
|@LockRelease
|int
|
|Pause warehouse release (manually authorization required)
0 - OFF
1 - ON
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
-1 - Automatic selection
|API_GetCustomers.ID
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union all
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-09-29T08:06:13Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - Entire only
|
|-
|@LockRelease
|int
|
|Pause warehouse release (manually authorization required)
0 - OFF
1 - ON
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
-1 - Automatic selection
|API_GetCustomers.ID
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-09-29T07:56:36Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - Entire only
|
|-
|@LockRelease
|int
|
|Lock release
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
-1 - Automatic selection
|API_GetCustomers.ID
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-09-29T07:45:39Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
1 - Immediately,
2 - EntireOnly
|
|-
|@LockRelease
|int
|
|Lock release
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
|
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-09-29T07:44:05Z

Chrzaszcz:

==== Description ====
Method allows You to create new order in system.

==== Exact name ====
<code>API_CreateOrder</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@Series
|nvarchar(10)
|
|Series number starts. Format: Series+Year+Auto Increment Number
|
|-
|@CurrencyID
|int
|
|Currency ID
|API_GetCurrency.ID
|-
|@CurrencyInCurrencyID
|int
|
|Currency in currency ID
|API_GetCurrency.ID
|-
|@ExchangeRate
|decimal(18,6)
|
|Exchange rate
|
|-
|@CustomerBranchID
|int
|
|Customer branch ID
|API_GetCustomers.ID
|-
|@PaymentMethodID
|int
|
|Payment method ID
1 - Cash,
2 - Transfer,
3 - CardPersonally,
4 - Before,
5 - Voucher,
6 - DeliveryCash,
7 - GoPay,
8 - Payout
|
|-
|@SupplierOrderNo
|nvarchar(80)
|
|Supplier Order Number
|
|-
|@Note
|nvarchar(600)
|
|Note
|
|-
|@TransportID
|int
|
|Transport ID
|API_GetTransports.ID
|-
|@ExpeditionID
|int
|
|Expedition ID
|
|-
|@LockRelease
|int
|
|Lock release
|
|-
|@RealizationDate
|datetime
|
|Realization Date
|
|-
|@OrderTypeID
|int
|
|Order type ID
-1 - NA
0 - Personal,
1 - Warehouse,
2 - Intraday,
5 - Common,
6 - Warehouse (producer),
500 - Manufacturing (Assembly)
|
|-
|@SeparatedDocument
|int
|
|Separated document
0 - OFF
1 - ON
|
|-
|@FinalDocumentTypeID
|int
|
|Final document type ID
0 - OFF
5 - Receipt,
1 - Bank transfer invoice,
2 - Cash invoice,
10 - Delivery note
|
|-
|@WaitForNextOrder
|int
|
|Wait for next order
0 - OFF
1 - ON
|
|-
|@AddDeposits
|bit
|
|Add deposits
0 - NO
1 - YES
|
|-
|@DoNotOrderFromSupplier
|int
|
|Do not order from supplier
0 - Deactivated,
1 - Activated,
-1 - Automatic
|
|-
|@OrderNo
|nvarchar(25)
|
|Order number OUTPUT
|
|-
|@OrderID
|int
|
|Order ID OUTPUT
|
|}

==== Table-Valued Parameters Specification====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProduktGroupID
|int
|
|ProduktGroupID
|API_GetProductGroups.ID
|-
|SupplierID
|int
|
|Supplier ID
|
|-
|Quantity
|decimal(14,2)
|
|Quantity
|
|-
|PurchasePriceInCurrency
|decimal(19,6)
|
|Purchase price in currency
|
|-
|PurchasePriceAfterDiscountInCurrency
|decimal(19,6)
|
|Purchase price after discount in currency
|
|}

==== Return ====
Number : OK - Number of added items
-100 : Order could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @OrderItems dbo.ApiOrderItems
Declare @_OrderNo nvarchar(25)
Declare @_OrderID int

Insert INTO @OrderItems
SELECT 232157, -1, 2, 300, 370
Union
SELECT 5650223, -1, 1, 20, 30

exec @return_value = dbo.[API_CreateOrder]
@Series = 'ORD',
@CurrencyID = 16034,
@CurrencyInCurrencyID = 16034,
@ExchangeRate = 1,
@CustomerBranchID = 75,
@PaymentMethodID = 2,
@SupplierOrderNo = '',
@Note = 'Some note',
@TransportID = 2,
@ExpeditionID = 1,
@LockRelease = 0,
@RealizationDate = -1,
@OrderTypeID = 0,
@SeparatedDocument = 0,
@FinalDocumentTypeID = 0,
@WaitForNextOrder = 0,
@AddDeposits = 0,
@DoNotOrderFromSupplier = -1,
@OrderItems = @OrderItems,
@OrderNo = @_OrderNo OUTPUT,
@OrderID = @_OrderID OUTPUT

Select @return_value, @_OrderNo, @_OrderID</syntaxhighlight>

==== Notices ====
API_CreateOrder procedure uses own data type called OrderItems (dbo.ApiOrderItems).

API CreateOrder

2020-09-29T06:53:35Z

Chrzaszcz:

API CreateOrder

2020-09-25T15:09:20Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to create new order in system. ==== Exact name ==== <code>API_CreateOrder</code> ==== Type ==== Standard executab…“

API EN DATA METHOD DESC

2020-09-25T13:42:07Z

Chrzaszcz:

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_CreateOrder]]
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[Send Order]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroups_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API GetCustomerSettings

2020-08-13T10:31:56Z

Chrzaszcz:

====Description====
Method gives You overview of existing customer settings in system.
====Exact name====
<code>API_GetCustomerSettings</code>
====Type====
Standard view.
====Specification====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|CustomerID
|int
|Internal system id
ID of customer from customer list (see relation)
|API_GetCustomers.ID
|-
|IsChildRegistrationEnabled
|int
|Is child registration enabled
|
|-
|IsBlocked
|int
|Is blocked
|
|-
|DefaultPaymentType
|int
|Default payment type:
0 = Default - cash,

1 = cash,

2 = transfer
|
|-
|DueType
|int
|IF DefaultPaymentType = 2. Due type:

0 = Default - Global setting,

1 = Global setting,

2 = Individual setting
|
|-
|DueDays
|int
|If DefaultPaymentType = 2 and DueType = 2. Due days:

0 = Default
|
|-
|CorrectionPaymentType
|int
|Correction payment type:
1 = Default - cash,

2 = transfer
|
|-
|CorrectionPaymentRange
|int
|If CorrectionPaymentType = 2. Correction payment range:

0 = Default - Global setting,

1 = Individual setting
|
|-
|CorrectionPaymentRangeDays
|int
|If CorrectionPaymentType = 2 and CorrectionPaymentRange = 1. Correction payment range days:

0 = Default
|
|}
====Example====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetCustomerSettings]
</syntaxhighlight>
====Notices ====
None.

API UpdateCustomer

2020-08-13T10:24:59Z

Chrzaszcz:

==== Description ====
Method allows You to update customer in system.

==== Exact name ====
<code>API_UpdateCustomer</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetCustomers.ID
|-
|@ShortName
|nvarchar(30)
|
|Short name
|
|-
|@CompanyName
|nvarchar(250)
|
|Company name
|
|-
|@CompanyRegistrationNumber
|nvarchar(20)
|
|Company registration number
|
|-
|@VATNumber
|nvarchar(20)
|
|VAT number
|
|-
|@VATNumber2
|nvarchar(15)
|
|VAT number 2
|
|-
|@VATPayer
|int
|
|VATPayer
|
|-
|@TransportID
|int
|
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|@Username
|nvarchar(255)
|
|Username
|
|-
|@Password
|nvarchar(25)
|
|Password
|
|-
|@OrderConfirmationPassword
|nvarchar(25)
|
|Order confirmation password
|
|-
|@Street
|nvarchar(100)
|
|Street
|
|-
|@City
|nvarchar(80)
|
|City
|
|-
|@ZIPCode
|nvarchar(15)
|
|ZIP code
|
|-
|@Region
|nvarchar(30)
|
|Region
|
|-
|@Country
|nvarchar(50)
|
|Country
|
|-
|@FileMarkText
|nvarchar(200)
|
|File mark text
|
|-
|@BranchID
|int
|
|ID of branche from branch list (see relation)
|API_GetBranches.ID
|-
|@WorkshopID
|int
|
|ID of workshop from workshop list (see relation)
|API_GetWorkshops.ID
|-
|@StockID
|int
|
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|@CurrencyID
|int
|
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|@State
|int
|
|ID of country from country list (see relation)
|API_GetCountry.ID
|-
|@SendOrderConfirmationEmail
|int
|
|Send order confirmation email
|
|-
|@OrderConfirmationEmail
|nvarchar(100)
|
|Order confirmation email
|
|-
|@Email
|nvarchar(100)
|
|Email
|
|-
|@EshopEmails
|nvarchar(400)
|
|Eshop emails
|
|-
|@IsBuyer
|int
|
|Is buyer
|
|-
|@IsSupplier
|int
|
|Is supplier
|
|-
|@IsCompetition
|int
|
|Is competition
|
|-
|@IsWSInvoicesExportAllowed
|bit
|
|Is WS invoices export allowed
|
|-
|@IsWSDeliveryNotesExportAllowed
|bit
|
|Is WS delivery notes export Allowed
|
|-
|@IsWSImportOrdersAllowed
|bit
|
|Is WS import orders Allowed
|
|-
|@StoreBackOrder
|int
|
|Store backorder
|
|-
|@IsSupplierIndividualOrders
|int
|
|Is supplier individual orders
|
|-
|@IsSupplierShortcut
|nvarchar(10)
|
|Is supplier shortcut
|
|-
|@Note
|nvarchar(500)
|
|Note
|
|-
|@Note2
|nvarchar(500)
|
|Note 2
|
|-
|@GlobalPricing
|int
|
|Global pricing
|
|-
|@OrderGroup
|nvarchar(10)
|
|Order group
|
|-
|@GPSLatitude
|nvarchar(20)
|
|GPS latitude
|
|-
|@GPSLongitude
|nvarchar(20)
|
|GPS longitude
|
|-
|@ParentID
|int
|
|ParentID
|
|-
|@IsArchiving
|int
|
|Is archiving
|
|-
|@VisibleProductsAmountOnStockLimit
|int
|
|Visible products amount on stock limit
-1 = Default,

0 = Picture,

5 = up to 5 products,

10 = up to 10 products,

1000 = full amount
|
|-
|@AreOrdersVisible
|int
|
|Are visible orders:
-1 = Default,

0 = Off,

1 = On
|
|-
|@DeliveryAddressID
|int
|
|ID of delivery address from customer list (see relation).
-1 = Default
|API_GetCustomers.ID
|-
|@DefaultPaymentType
|int
|
|Default payment type:
0 = Default - cash,

1 = cash,

2 = transfer
|
|-
|@DueType
|int
|
|IF @DefaultPaymentType = 2. Due type:
0 = Default - Global setting,

1 = Global setting,

2 = Individual setting
|
|-
|@DueDays
|int
|
|If @DefaultPaymentType = 2 and @DueType = 2. Due days:
0 = Default
|
|-
|@CorrectionPaymentType
|int
|
|Correction payment type:
1 = Default - cash,

2 = transfer
|
|-
|@CorrectionPaymentRange
|int
|
|If @CorrectionPaymentType = 2. Correction payment range:
0 = Default - Global setting,

1 = Individual setting
|
|-
|@CorrectionPaymentRangeDays
|int
|
|If @CorrectionPaymentType = 2 and @CorrectionPaymentRange = 1. Correction payment range days:
0 = Default
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @ShortName nvarchar(30)
DECLARE @CompanyName nvarchar(250)
DECLARE @CompanyRegistrationNumber nvarchar(20)
DECLARE @VATNumber nvarchar(20)
DECLARE @VATNumber2 nvarchar(15)
DECLARE @VATPayer int
DECLARE @TransportID int
DECLARE @Username nvarchar(20)
DECLARE @Password nvarchar(25)
DECLARE @OrderConfirmationPassword nvarchar(25)
DECLARE @Street nvarchar(100)
DECLARE @City nvarchar(80)
DECLARE @ZIPCode nvarchar(15)
DECLARE @Region nvarchar(30)
DECLARE @Country nvarchar(50)
DECLARE @FileMarkText nvarchar(200)
DECLARE @BranchID int
DECLARE @WorkshopID int
DECLARE @StockID int
DECLARE @CurrencyID int
DECLARE @State int
DECLARE @SendOrderConfirmationEmail int
DECLARE @OrderConfirmationEmail nvarchar(100)
DECLARE @Email nvarchar(100)
DECLARE @EShopEMails nvarchar(400)
DECLARE @IsBuyer bit
DECLARE @IsSupplier bit
DECLARE @IsCompetition bit
DECLARE @IsWSInvoicesExportAllowed bit
DECLARE @IsWSDeliveryNotesExportAllowed bit
DECLARE @IsWSImportOrdersAllowed bit
DECLARE @StoreBackOrder bit
DECLARE @IsSupplierIndividualOrders bit
DECLARE @IsSupplierShortcut nvarchar(10)
DECLARE @Note nvarchar(500)
DECLARE @Note2 nvarchar(500)
DECLARE @GlobalPricing bit
DECLARE @OrderGroup nvarchar(10)
DECLARE @GPSLatitude nvarchar(20)
DECLARE @GPSLongitude nvarchar(20)
DECLARE @ParentID int
DECLARE @IsArchiving int
DECLARE @VisibleProductsAmountOnStockLimit int
DECLARE @AreOrdersVisible int
DECLARE @DeliveryAddressID int
DECLARE @DefaultPaymentType int
DECLARE @DueType int
DECLARE @DueDays int
DECLARE @CorrectionPaymentType int
DECLARE @CorrectionPaymentRange int
DECLARE @CorrectionPaymentRangeDays int

SELECT @ID = G.[ID],
@ShortName = G.[ShortName],
@CompanyName = G.[CompanyName],
@CompanyRegistrationNumber = G.[CompanyRegistrationNumber],
@VATNumber = G.[VATNumber],
@VATNumber2 = G.[VATNumber2],
@VATPayer = G.[VATPayer],
@TransportID = G.[TransportID],
@Username = G.[Username],
@Password = G.[Password],
@OrderConfirmationPassword = G.[OrderConfirmationPassword],
@Street = G.[Street],
@City = G.[City],
@ZIPCode = G.[ZIPCode],
@Region = G.[Region],
@Country = G.[Country],
@FileMarkText = G.[FileMarkText],
@BranchID = G.[BranchID],
@WorkshopID = G.[WorkshopID],
@StockID = G.[StockID],
@CurrencyID = G.[CurrencyID],
@State = G.[State],
@SendOrderConfirmationEmail = G.[SendOrderConfirmationEmail],
@OrderConfirmationEmail = G.[OrderConfirmationEmail],
@Email = G.[Email],
@EShopEMails = G.[EShopEMails],
@IsBuyer = G.[IsBuyer],
@IsSupplier = G.[IsSupplier],
@IsCompetition = G.[IsCompetition],
@IsWSInvoicesExportAllowed = G.[IsWSInvoicesExportAllowed],
@IsWSDeliveryNotesExportAllowed = G.[IsWSDeliveryNotesExportAllowed],
@IsWSImportOrdersAllowed = G.[IsWSImportOrdersAllowed],
@StoreBackOrder = G.[StoreBackOrder],
@IsSupplierIndividualOrders = G.[IsSupplierIndividualOrders],
@IsSupplierShortcut = G.[IsSupplierShortcut],
@Note = G.[Note],
@Note2 = G.[Note2],
@GlobalPricing = G.[GlobalPricing],
@OrderGroup = G.[OrderGroup],
@GPSLatitude = G.[GPSLatitude],
@GPSLongitude = G.[GPSLongitude],
@ParentID = G.[ParentID],
@IsArchiving = G.[IsArchiving],
@VisibleProductsAmountOnStockLimit = G.[VisibleProductsAmountOnStockLimit],
@AreOrdersVisible = G.[AreOrdersVisible],
@DeliveryAddressID = G.[DeliveryAddressID],
@DefaultPaymentType = S.[DefaultPaymentType],
@DueType = S.[DueType],
@DueDays = S.[DueDays],
@CorrectionPaymentType = S.[CorrectionPaymentType],
@CorrectionPaymentRange = S.[CorrectionPaymentRange],
@CorrectionPaymentRangeDays = S.[CorrectionPaymentRangeDays]
FROM [API_GetCustomers] G
LEFT JOIN [API_GetCustomerSettings] S ON G.ID = S.CustomerID
WHERE G.ID = 3

EXECUTE @return_value = [API_UpdateCustomer]
@ID,
@ShortName,
@CompanyName,
@CompanyRegistrationNumber,
@VATNumber,
@VATNumber2,
@VATPayer,
@TransportID,
@Username,
@Password,
@OrderConfirmationPassword,
@Street,
@City,
@ZIPCode,
@Region,
@Country,
@FileMarkText,
@BranchID,
@WorkshopID,
@StockID,
@CurrencyID,
@State,
@SendOrderConfirmationEmail,
@OrderConfirmationEmail,
@Email,
@EShopEMails,
@IsBuyer,
@IsSupplier,
@IsCompetition,
@IsWSInvoicesExportAllowed,
@IsWSDeliveryNotesExportAllowed,
@IsWSImportOrdersAllowed,
@StoreBackOrder,
@IsSupplierIndividualOrders,
@IsSupplierShortcut,
@Note,
@Note2,
@GlobalPricing,
@OrderGroup,
@GPSLatitude,
@GPSLongitude,
@ParentID,
@IsArchiving,
@VisibleProductsAmountOnStockLimit,
@AreOrdersVisible,
@DeliveryAddressID,
@DefaultPaymentType,
@DueType,
@DueDays,
@CorrectionPaymentType,
@CorrectionPaymentRange,
@CorrectionPaymentRangeDays

</syntaxhighlight>

==== Notices ====
None.

API UpdateCustomer

2020-08-13T10:23:34Z

Chrzaszcz:

==== Description ====
Method allows You to update customer in system.

==== Exact name ====
<code>API_UpdateCustomer</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetCustomers.ID
|-
|@ShortName
|nvarchar(30)
|
|Short name
|
|-
|@CompanyName
|nvarchar(250)
|
|Company name
|
|-
|@CompanyRegistrationNumber
|nvarchar(20)
|
|Company registration number
|
|-
|@VATNumber
|nvarchar(20)
|
|VAT number
|
|-
|@VATNumber2
|nvarchar(15)
|
|VAT number 2
|
|-
|@VATPayer
|int
|
|VATPayer
|
|-
|@TransportID
|int
|
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|@Username
|nvarchar(255)
|
|Username
|
|-
|@Password
|nvarchar(25)
|
|Password
|
|-
|@OrderConfirmationPassword
|nvarchar(25)
|
|Order confirmation password
|
|-
|@Street
|nvarchar(100)
|
|Street
|
|-
|@City
|nvarchar(80)
|
|City
|
|-
|@ZIPCode
|nvarchar(15)
|
|ZIP code
|
|-
|@Region
|nvarchar(30)
|
|Region
|
|-
|@Country
|nvarchar(50)
|
|Country
|
|-
|@FileMarkText
|nvarchar(200)
|
|File mark text
|
|-
|@BranchID
|int
|
|ID of branche from branch list (see relation)
|API_GetBranches.ID
|-
|@WorkshopID
|int
|
|ID of workshop from workshop list (see relation)
|API_GetWorkshops.ID
|-
|@StockID
|int
|
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|@CurrencyID
|int
|
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|@State
|int
|
|ID of country from country list (see relation)
|API_GetCountry.ID
|-
|@SendOrderConfirmationEmail
|int
|
|Send order confirmation email
|
|-
|@OrderConfirmationEmail
|nvarchar(100)
|
|Order confirmation email
|
|-
|@Email
|nvarchar(100)
|
|Email
|
|-
|@EshopEmails
|nvarchar(400)
|
|Eshop emails
|
|-
|@IsBuyer
|int
|
|Is buyer
|
|-
|@IsSupplier
|int
|
|Is supplier
|
|-
|@IsCompetition
|int
|
|Is competition
|
|-
|@IsWSInvoicesExportAllowed
|bit
|
|Is WS invoices export allowed
|
|-
|@IsWSDeliveryNotesExportAllowed
|bit
|
|Is WS delivery notes export Allowed
|
|-
|@IsWSImportOrdersAllowed
|bit
|
|Is WS import orders Allowed
|
|-
|@StoreBackOrder
|int
|
|Store backorder
|
|-
|@IsSupplierIndividualOrders
|int
|
|Is supplier individual orders
|
|-
|@IsSupplierShortcut
|nvarchar(10)
|
|Is supplier shortcut
|
|-
|@Note
|nvarchar(500)
|
|Note
|
|-
|@Note2
|nvarchar(500)
|
|Note 2
|
|-
|@GlobalPricing
|int
|
|Global pricing
|
|-
|@OrderGroup
|nvarchar(10)
|
|Order group
|
|-
|@GPSLatitude
|nvarchar(20)
|
|GPS latitude
|
|-
|@GPSLongitude
|nvarchar(20)
|
|GPS longitude
|
|-
|@ParentID
|int
|
|ParentID
|
|-
|@IsArchiving
|int
|
|Is archiving
|
|-
|@VisibleProductsAmountOnStockLimit
|int
|
|Visible products amount on stock limit
-1 = Default,

0 = Picture,

5 = up to 5 products,

10 = up to 10 products,

1000 = full amount
|
|-
|@AreOrdersVisible
|int
|
|Are visible orders:
-1 = Default,

0 = Off,

1 = On
|
|-
|@DeliveryAddressID
|int
|
|ID of delivery address from customer list (see relation).
-1 = Default
|API_GetCustomers.ID
|-
|@DefaultPaymentType
|int
|
|Default payment type:
0 = Default - cash,

1 = cash,

2 = transfer
|
|-
|@DueType
|int
|
|IF @DefaultPaymentType = 2. Due type:
0 = Default - Global setting,

1 = Global setting,

2 = Individual setting
|
|-
|@DueDays
|int
|
|If @DefaultPaymentType = 2 and @DueType = 2. Due days:
0 = Default
|
|-
|@CorrectionPaymentType
|int
|
|Correction payment type:
1 = Default - cash,

2 = transfer
|
|-
|@CorrectionPaymentRange
|int
|
|If @CorrectionPaymentType = 2. Correction payment range:
0 = Default - Global setting,

1 = Individual setting
|
|-
|@CorrectionPaymentRangeDays
|int
|
|If @CorrectionPaymentType = 2 and @CorrectionPaymentRange = 1. Correction payment range days:
0 = Default
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @ShortName nvarchar(30)
DECLARE @CompanyName nvarchar(250)
DECLARE @CompanyRegistrationNumber nvarchar(20)
DECLARE @VATNumber nvarchar(20)
DECLARE @VATNumber2 nvarchar(15)
DECLARE @VATPayer int
DECLARE @TransportID int
DECLARE @Username nvarchar(20)
DECLARE @Password nvarchar(25)
DECLARE @OrderConfirmationPassword nvarchar(25)
DECLARE @Street nvarchar(100)
DECLARE @City nvarchar(80)
DECLARE @ZIPCode nvarchar(15)
DECLARE @Region nvarchar(30)
DECLARE @Country nvarchar(50)
DECLARE @FileMarkText nvarchar(200)
DECLARE @BranchID int
DECLARE @WorkshopID int
DECLARE @StockID int
DECLARE @CurrencyID int
DECLARE @State int
DECLARE @SendOrderConfirmationEmail int
DECLARE @OrderConfirmationEmail nvarchar(100)
DECLARE @Email nvarchar(100)
DECLARE @EShopEMails nvarchar(400)
DECLARE @IsBuyer bit
DECLARE @IsSupplier bit
DECLARE @IsCompetition bit
DECLARE @IsWSInvoicesExportAllowed bit
DECLARE @IsWSDeliveryNotesExportAllowed bit
DECLARE @IsWSImportOrdersAllowed bit
DECLARE @StoreBackOrder bit
DECLARE @IsSupplierIndividualOrders bit
DECLARE @IsSupplierShortcut nvarchar(10)
DECLARE @Note nvarchar(500)
DECLARE @Note2 nvarchar(500)
DECLARE @GlobalPricing bit
DECLARE @OrderGroup nvarchar(10)
DECLARE @GPSLatitude nvarchar(20)
DECLARE @GPSLongitude nvarchar(20)
DECLARE @ParentID int
DECLARE @IsArchiving int
DECLARE @VisibleProductsAmountOnStockLimit int
DECLARE @AreOrdersVisible int
DECLARE @DeliveryAddressID int
DECLARE @DefaultPaymentType int
DECLARE @DueType int
DECLARE @DueDays int
DECLARE @CorrectionPaymentType int
DECLARE @CorrectionPaymentRange int
DECLARE @CorrectionPaymentRangeDays int

SELECT @ID = G.[ID],
@ShortName = G.[ShortName],
@CompanyName = G.[CompanyName],
@CompanyRegistrationNumber = G.[CompanyRegistrationNumber],
@VATNumber = G.[VATNumber],
@VATNumber2 = G.[VATNumber2],
@VATPayer = G.[VATPayer],
@TransportID = G.[TransportID],
@Username = G.[Username],
@Password = G.[Password],
@OrderConfirmationPassword = G.[OrderConfirmationPassword],
@Street = G.[Street],
@City = G.[City],
@ZIPCode = G.[ZIPCode],
@Region = G.[Region],
@Country = G.[Country],
@FileMarkText = G.[FileMarkText],
@BranchID = G.[BranchID],
@WorkshopID = G.[WorkshopID],
@StockID = G.[StockID],
@CurrencyID = G.[CurrencyID],
@State = G.[State],
@SendOrderConfirmationEmail = G.[SendOrderConfirmationEmail],
@OrderConfirmationEmail = G.[OrderConfirmationEmail],
@Email = G.[Email],
@EShopEMails = G.[EShopEMails],
@IsBuyer = G.[IsBuyer],
@IsSupplier = G.[IsSupplier],
@IsCompetition = G.[IsCompetition],
@IsWSInvoicesExportAllowed = G.[IsWSInvoicesExportAllowed],
@IsWSDeliveryNotesExportAllowed = G.[IsWSDeliveryNotesExportAllowed],
@IsWSImportOrdersAllowed = G.[IsWSImportOrdersAllowed],
@StoreBackOrder = G.[StoreBackOrder],
@IsSupplierIndividualOrders = G.[IsSupplierIndividualOrders],
@IsSupplierShortcut = G.[IsSupplierShortcut],
@Note = G.[Note],
@Note2 = G.[Note2],
@GlobalPricing = G.[GlobalPricing],
@OrderGroup = G.[OrderGroup],
@GPSLatitude = G.[GPSLatitude],
@GPSLongitude = G.[GPSLongitude],
@ParentID = G.[ParentID],
@IsArchiving = G.[IsArchiving],
@VisibleProductsAmountOnStockLimit = G.[VisibleProductsAmountOnStockLimit],
@AreOrdersVisible = G.[AreOrdersVisible],
@DeliveryAddressID = G.[DeliveryAddressID],
@DefaultPaymentType = [DefaultPaymentType],
@DueType = [DueType],
@DueDays = [DueDays],
@CorrectionPaymentType = [CorrectionPaymentType],
@CorrectionPaymentRange = [CorrectionPaymentRange],
@CorrectionPaymentRangeDays = [CorrectionPaymentRangeDays]
FROM [API_GetCustomers] G
LEFT JOIN [API_GetCustomerSettings] S ON G.ID = S.CustomerID
WHERE G.ID = 3

EXECUTE @return_value = [API_UpdateCustomer]
@ID,
@ShortName,
@CompanyName,
@CompanyRegistrationNumber,
@VATNumber,
@VATNumber2,
@VATPayer,
@TransportID,
@Username,
@Password,
@OrderConfirmationPassword,
@Street,
@City,
@ZIPCode,
@Region,
@Country,
@FileMarkText,
@BranchID,
@WorkshopID,
@StockID,
@CurrencyID,
@State,
@SendOrderConfirmationEmail,
@OrderConfirmationEmail,
@Email,
@EShopEMails,
@IsBuyer,
@IsSupplier,
@IsCompetition,
@IsWSInvoicesExportAllowed,
@IsWSDeliveryNotesExportAllowed,
@IsWSImportOrdersAllowed,
@StoreBackOrder,
@IsSupplierIndividualOrders,
@IsSupplierShortcut,
@Note,
@Note2,
@GlobalPricing,
@OrderGroup,
@GPSLatitude,
@GPSLongitude,
@ParentID,
@IsArchiving,
@VisibleProductsAmountOnStockLimit,
@AreOrdersVisible,
@DeliveryAddressID,
@DefaultPaymentType,
@DueType,
@DueDays,
@CorrectionPaymentType,
@CorrectionPaymentRange,
@CorrectionPaymentRangeDays

</syntaxhighlight>

==== Notices ====
None.

API CreateCustomer

2020-08-13T09:31:15Z

Chrzaszcz:

==== Description ====
Method allows You to create new customer in system.

==== Exact name ====
<code>API_CreateCustomer</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ShortName
|nvarchar(30)
|
|Short name
|
|-
|@CompanyName
|nvarchar(250)
|
|Company name
|
|-
|@CompanyRegistrationNumber
|nvarchar(20)
|
|Company registration number
|
|-
|@VATNumber
|nvarchar(20)
|
|VAT number
|
|-
|@VATNumber2
|nvarchar(15)
|
|VAT number 2
|
|-
|@VATPayer
|int
|
|VATPayer
|
|-
|@TransportID
|int
|
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|@Username
|nvarchar(255)
|
|Username
|
|-
|@Password
|nvarchar(25)
|
|Password
|
|-
|@OrderConfirmationPassword
|nvarchar(25)
|
|Order confirmation password
|
|-
|@Street
|nvarchar(100)
|
|Street
|
|-
|@City
|nvarchar(80)
|
|City
|
|-
|@ZIPCode
|nvarchar(15)
|
|ZIP code
|
|-
|@State
|int
|
|ID of country from country list (see relation)
|API_GetCountry.ID
|-
|@BranchID
|int
|
|ID of branche from branch list (see relation)
|API_GetBranches.ID
|-
|@WorkshopID
|int
|
|ID of workshop from workshop list (see relation)
|API_GetWorkshops.ID
|-
|@StockID
|int
|
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|@CurrencyID
|int
|
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|@SendOrderConfirmationEmail
|int
|
|Send order confirmation email
|
|-
|@OrderConfirmationEmail
|nvarchar(100)
|
|Order confirmation email
|
|-
|@Email
|nvarchar(100)
|
|Email
|
|-
|@EshopEmails
|nvarchar(400)
|
|Eshop emails
|
|-
|@IsBuyer
|int
|
|Is buyer
|
|-
|@IsSupplier
|int
|
|Is supplier
|
|-
|@Region
|nvarchar(30)
|
|Region
|
|-
|@Country
|nvarchar(50)
|
|Country
|
|-
|@IsCompetition
|int
|
|Is competition
|
|-
|@FileMarkText
|nvarchar(200)
|
|File mark text
|
|-
|@IsWSInvoicesExportAllowed
|bit
|
|Is WS invoices export allowed
|
|-
|@IsWSDeliveryNotesExportAllowed
|bit
|
|Is WS delivery notes export Allowed
|
|-
|@IsWSImportOrdersAllowed
|bit
|
|Is WS import orders Allowed
|
|-
|@StoreBackOrder
|int
|
|Store backorder
|
|-
|@IsSupplierIndividualOrders
|int
|
|Is supplier individual orders
|
|-
|@IsSupplierShortcut
|nvarchar(10)
|
|Is supplier shortcut
|
|-
|@Note
|nvarchar(500)
|
|Note
|
|-
|@Note2
|nvarchar(500)
|
|Note 2
|
|-
|@GlobalPricing
|int
|
|Global pricing
|
|-
|@OrderGroup
|nvarchar(10)
|
|Order group
|
|-
|@GPSLatitude
|nvarchar(20)
|
|GPS latitude
|
|-
|@GPSLongitude
|nvarchar(20)
|
|GPS longitude
|
|-
|@ParentID
|int
|
|ParentID
|
|-
|@VisibleProductsAmountOnStockLimit
|int
|
|Visible products amount on stock limit
-1 = Default,

0 = Picture,

5 = up to 5 products,

10 = up to 10 products,

1000 = full amount
|
|-
|@AreOrdersVisible
|int
|
|Are visible orders:
-1 = Default,

0 = Off,

1 = On
|
|-
|@DeliveryAddressID
|int
|
|ID of delivery address from customer list (see relation).
-1 = Default
|API_GetCustomers.ID
|-
|@DefaultPaymentType
|int
|
|Default payment type:
0 = Default - cash,

1 = cash,

2 = transfer
|
|-
|@DueType
|int
|
|IF @DefaultPaymentType = 2. Due type:
0 = Default - Global setting,

1 = Global setting,

2 = Individual setting
|
|-
|@DueDays
|int
|
|If @DefaultPaymentType = 2 and @DueType = 2. Due days:
0 = Default
|
|-
|@CorrectionPaymentType
|int
|
|Correction payment type:
1 = Default - cash,

2 = transfer
|
|-
|@CorrectionPaymentRange
|int
|
|If @CorrectionPaymentType = 2. Correction payment range:
0 = Default - Global setting,

1 = Individual setting
|
|-
|@CorrectionPaymentRangeDays
|int
|
|If @CorrectionPaymentType = 2 and @CorrectionPaymentRange = 1. Correction payment range days:
0 = Default
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateCustomer] @ShortName= 'ShortName' ,@CompanyName= 'CompanyName' ,@CompanyRegistrationNumber= 'CompanyRegistrationNumber' ,@VATNumber= 'VATNumber' ,@VATNumber2= 'VATNumber2' ,@VATPayer= 1 ,@TransportID= 1 ,@Username= 'Username' ,@Password= 'Password' ,@OrderConfirmationPassword= 'OrderConfirmationPassword' ,@Street= 'Street' ,@City= 'City' ,@ZIPCode= 'ZIPCode' ,@State= 15797 ,@BranchID= 1 ,@WorkshopID= 1 ,@StockID= 1 ,@CurrencyID= 144 ,@SendOrderConfirmationEmail= 0 ,@OrderConfirmationEmail= 'OrderConfirmationEmail' ,@Email= 'Email' ,@EshopEmails= 'EshopEmails' ,@IsBuyer= 0 ,@IsSupplier= 0 ,@Region= 'Region' ,@Country= 'Country' ,@IsCompetition= 0 ,@FileMarkText= 'FileMarkText' ,@IsWSInvoicesExportAllowed= 0 ,@IsWSDeliveryNotesExportAllowed= 0 ,@IsWSImportOrdersAllowed= 0 ,@StoreBackOrder= 0 ,@IsSupplierIndividualOrders= 0 ,@IsSupplierShortcut= 'IsSupplierShortcut' ,@Note= 'Note' ,@Note2= 'Note2' ,@GlobalPricing= 0 ,@OrderGroup= 'OrderGroup' ,@GPSLatitude= 'GPSLatitude' ,@GPSLongitude= 'GPSLongitude' ,@ParentID= -1, @VisibleProductsAmountOnStockLimit = 10, @AreOrdersVisible = 1, @DeliveryAddressID = -1, @DefaultPaymentType = 1, @DueType = 1, @DueDays = 0, @CorrectionPaymentType = 1, @CorrectionPaymentRange = 0, @CorrectionPaymentRangeDays = 0
</syntaxhighlight>

==== Notices ====
None.

API CreateCustomer

2020-08-13T09:28:44Z

Chrzaszcz:

==== Description ====
Method allows You to create new customer in system.

==== Exact name ====
<code>API_CreateCustomer</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ShortName
|nvarchar(30)
|
|Short name
|
|-
|@CompanyName
|nvarchar(250)
|
|Company name
|
|-
|@CompanyRegistrationNumber
|nvarchar(20)
|
|Company registration number
|
|-
|@VATNumber
|nvarchar(20)
|
|VAT number
|
|-
|@VATNumber2
|nvarchar(15)
|
|VAT number 2
|
|-
|@VATPayer
|int
|
|VATPayer
|
|-
|@TransportID
|int
|
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|@Username
|nvarchar(255)
|
|Username
|
|-
|@Password
|nvarchar(25)
|
|Password
|
|-
|@OrderConfirmationPassword
|nvarchar(25)
|
|Order confirmation password
|
|-
|@Street
|nvarchar(100)
|
|Street
|
|-
|@City
|nvarchar(80)
|
|City
|
|-
|@ZIPCode
|nvarchar(15)
|
|ZIP code
|
|-
|@State
|int
|
|ID of country from country list (see relation)
|API_GetCountry.ID
|-
|@BranchID
|int
|
|ID of branche from branch list (see relation)
|API_GetBranches.ID
|-
|@WorkshopID
|int
|
|ID of workshop from workshop list (see relation)
|API_GetWorkshops.ID
|-
|@StockID
|int
|
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|@CurrencyID
|int
|
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|@SendOrderConfirmationEmail
|int
|
|Send order confirmation email
|
|-
|@OrderConfirmationEmail
|nvarchar(100)
|
|Order confirmation email
|
|-
|@Email
|nvarchar(100)
|
|Email
|
|-
|@EshopEmails
|nvarchar(400)
|
|Eshop emails
|
|-
|@IsBuyer
|int
|
|Is buyer
|
|-
|@IsSupplier
|int
|
|Is supplier
|
|-
|@Region
|nvarchar(30)
|
|Region
|
|-
|@Country
|nvarchar(50)
|
|Country
|
|-
|@IsCompetition
|int
|
|Is competition
|
|-
|@FileMarkText
|nvarchar(200)
|
|File mark text
|
|-
|@IsWSInvoicesExportAllowed
|bit
|
|Is WS invoices export allowed
|
|-
|@IsWSDeliveryNotesExportAllowed
|bit
|
|Is WS delivery notes export Allowed
|
|-
|@IsWSImportOrdersAllowed
|bit
|
|Is WS import orders Allowed
|
|-
|@StoreBackOrder
|int
|
|Store backorder
|
|-
|@IsSupplierIndividualOrders
|int
|
|Is supplier individual orders
|
|-
|@IsSupplierShortcut
|nvarchar(10)
|
|Is supplier shortcut
|
|-
|@Note
|nvarchar(500)
|
|Note
|
|-
|@Note2
|nvarchar(500)
|
|Note 2
|
|-
|@GlobalPricing
|int
|
|Global pricing
|
|-
|@OrderGroup
|nvarchar(10)
|
|Order group
|
|-
|@GPSLatitude
|nvarchar(20)
|
|GPS latitude
|
|-
|@GPSLongitude
|nvarchar(20)
|
|GPS longitude
|
|-
|@ParentID
|int
|
|ParentID
|
|-
|@VisibleProductsAmountOnStockLimit
|int
|
|Visible products amount on stock limit
-1 = Default,

0 = Picture,

5 = up to 5 products,

10 = up to 10 products,

1000 = full amount
|
|-
|@AreOrdersVisible
|int
|
|Are visible orders:
-1 = Default,

0 = Off,

1 = On
|
|-
|@DeliveryAddressID
|int
|
|ID of delivery address from customer list (see relation).
-1 = Default
|API_GetCustomers.ID
|-
|@DefaultPaymentType
|int
|
|Default payment type:
0 = Default - cash,

1 = cash,

2 = transfer
|
|-
|@DueType
|int
|
|IF @DefaultPaymentType = 2. Due type:
0 = Default - Global setting,

1 = Global setting,

2 = Individual setting
|
|-
|@DueDays
|int
|
|If @DefaultPaymentType = 2. Due days:
0 = Default
|
|-
|@CorrectionPaymentType
|int
|
|Correction payment type:
1 = Default - cash,

2 = transfer
|
|-
|@CorrectionPaymentRange
|int
|
|If @CorrectionPaymentType = 2. Correction payment range:
0 = Default - Global setting,

1 = Individual setting
|
|-
|@CorrectionPaymentRangeDays
|int
|
|If @CorrectionPaymentType = 2. Correction payment range days:
0 = Default
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateCustomer] @ShortName= 'ShortName' ,@CompanyName= 'CompanyName' ,@CompanyRegistrationNumber= 'CompanyRegistrationNumber' ,@VATNumber= 'VATNumber' ,@VATNumber2= 'VATNumber2' ,@VATPayer= 1 ,@TransportID= 1 ,@Username= 'Username' ,@Password= 'Password' ,@OrderConfirmationPassword= 'OrderConfirmationPassword' ,@Street= 'Street' ,@City= 'City' ,@ZIPCode= 'ZIPCode' ,@State= 15797 ,@BranchID= 1 ,@WorkshopID= 1 ,@StockID= 1 ,@CurrencyID= 144 ,@SendOrderConfirmationEmail= 0 ,@OrderConfirmationEmail= 'OrderConfirmationEmail' ,@Email= 'Email' ,@EshopEmails= 'EshopEmails' ,@IsBuyer= 0 ,@IsSupplier= 0 ,@Region= 'Region' ,@Country= 'Country' ,@IsCompetition= 0 ,@FileMarkText= 'FileMarkText' ,@IsWSInvoicesExportAllowed= 0 ,@IsWSDeliveryNotesExportAllowed= 0 ,@IsWSImportOrdersAllowed= 0 ,@StoreBackOrder= 0 ,@IsSupplierIndividualOrders= 0 ,@IsSupplierShortcut= 'IsSupplierShortcut' ,@Note= 'Note' ,@Note2= 'Note2' ,@GlobalPricing= 0 ,@OrderGroup= 'OrderGroup' ,@GPSLatitude= 'GPSLatitude' ,@GPSLongitude= 'GPSLongitude' ,@ParentID= -1, @VisibleProductsAmountOnStockLimit = 10, @AreOrdersVisible = 1, @DeliveryAddressID = -1, @DefaultPaymentType = 1, @DueType = 1, @DueDays = 0, @CorrectionPaymentType = 1, @CorrectionPaymentRange = 0, @CorrectionPaymentRangeDays = 0
</syntaxhighlight>

==== Notices ====
None.

API CreateCustomer

2020-08-13T09:26:40Z

Chrzaszcz:

==== Description ====
Method allows You to create new customer in system.

==== Exact name ====
<code>API_CreateCustomer</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ShortName
|nvarchar(30)
|
|Short name
|
|-
|@CompanyName
|nvarchar(250)
|
|Company name
|
|-
|@CompanyRegistrationNumber
|nvarchar(20)
|
|Company registration number
|
|-
|@VATNumber
|nvarchar(20)
|
|VAT number
|
|-
|@VATNumber2
|nvarchar(15)
|
|VAT number 2
|
|-
|@VATPayer
|int
|
|VATPayer
|
|-
|@TransportID
|int
|
|ID of transport from transport list (see relation)
|API_GetTransports.ID
|-
|@Username
|nvarchar(255)
|
|Username
|
|-
|@Password
|nvarchar(25)
|
|Password
|
|-
|@OrderConfirmationPassword
|nvarchar(25)
|
|Order confirmation password
|
|-
|@Street
|nvarchar(100)
|
|Street
|
|-
|@City
|nvarchar(80)
|
|City
|
|-
|@ZIPCode
|nvarchar(15)
|
|ZIP code
|
|-
|@State
|int
|
|ID of country from country list (see relation)
|API_GetCountry.ID
|-
|@BranchID
|int
|
|ID of branche from branch list (see relation)
|API_GetBranches.ID
|-
|@WorkshopID
|int
|
|ID of workshop from workshop list (see relation)
|API_GetWorkshops.ID
|-
|@StockID
|int
|
|ID of stock from stock list (see relation)
|API_GetStocks.ID
|-
|@CurrencyID
|int
|
|ID of currency from currency list (see relation)
|API_GetCurrency.ID
|-
|@SendOrderConfirmationEmail
|int
|
|Send order confirmation email
|
|-
|@OrderConfirmationEmail
|nvarchar(100)
|
|Order confirmation email
|
|-
|@Email
|nvarchar(100)
|
|Email
|
|-
|@EshopEmails
|nvarchar(400)
|
|Eshop emails
|
|-
|@IsBuyer
|int
|
|Is buyer
|
|-
|@IsSupplier
|int
|
|Is supplier
|
|-
|@Region
|nvarchar(30)
|
|Region
|
|-
|@Country
|nvarchar(50)
|
|Country
|
|-
|@IsCompetition
|int
|
|Is competition
|
|-
|@FileMarkText
|nvarchar(200)
|
|File mark text
|
|-
|@IsWSInvoicesExportAllowed
|bit
|
|Is WS invoices export allowed
|
|-
|@IsWSDeliveryNotesExportAllowed
|bit
|
|Is WS delivery notes export Allowed
|
|-
|@IsWSImportOrdersAllowed
|bit
|
|Is WS import orders Allowed
|
|-
|@StoreBackOrder
|int
|
|Store backorder
|
|-
|@IsSupplierIndividualOrders
|int
|
|Is supplier individual orders
|
|-
|@IsSupplierShortcut
|nvarchar(10)
|
|Is supplier shortcut
|
|-
|@Note
|nvarchar(500)
|
|Note
|
|-
|@Note2
|nvarchar(500)
|
|Note 2
|
|-
|@GlobalPricing
|int
|
|Global pricing
|
|-
|@OrderGroup
|nvarchar(10)
|
|Order group
|
|-
|@GPSLatitude
|nvarchar(20)
|
|GPS latitude
|
|-
|@GPSLongitude
|nvarchar(20)
|
|GPS longitude
|
|-
|@ParentID
|int
|
|ParentID
|
|-
|@VisibleProductsAmountOnStockLimit
|int
|
|Visible products amount on stock limit
-1 = Default,

0 = Picture,

5 = up to 5 products,

10 = up to 10 products,

1000 = full amount
|
|-
|@AreOrdersVisible
|int
|
|Are visible orders:
-1 = Default,

0 = Off,

1 = On
|
|-
|@DeliveryAddressID
|int
|
|ID of delivery address from customer list (see relation).
-1 = Default
|API_GetCustomers.ID
|-
|@DefaultPaymentType
|int
|
|Default payment type:
0 = Default - cash,
1 = cash,

2 = transfer
|
|-
|@DueType
|int
|
|IF @DefaultPaymentType = 2. Due type:
0 = Default - Global setting,
1 = Global setting,

2 = Individual setting
|
|-
|@DueDays
|int
|
|If @DefaultPaymentType = 2. Due days:
0 = Default
|
|-
|@CorrectionPaymentType
|int
|
|Correction payment type:
1 = Default - cash,

2 = transfer
|
|-
|@CorrectionPaymentRange
|int
|
|If @CorrectionPaymentType = 2. Correction payment range:
0 = Default - Global setting,

1 = Individual setting
|
|-
|@CorrectionPaymentRangeDays
|int
|
|If @CorrectionPaymentType = 2. Correction payment range days:
0 = Default
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateCustomer] @ShortName= 'ShortName' ,@CompanyName= 'CompanyName' ,@CompanyRegistrationNumber= 'CompanyRegistrationNumber' ,@VATNumber= 'VATNumber' ,@VATNumber2= 'VATNumber2' ,@VATPayer= 1 ,@TransportID= 1 ,@Username= 'Username' ,@Password= 'Password' ,@OrderConfirmationPassword= 'OrderConfirmationPassword' ,@Street= 'Street' ,@City= 'City' ,@ZIPCode= 'ZIPCode' ,@State= 15797 ,@BranchID= 1 ,@WorkshopID= 1 ,@StockID= 1 ,@CurrencyID= 144 ,@SendOrderConfirmationEmail= 0 ,@OrderConfirmationEmail= 'OrderConfirmationEmail' ,@Email= 'Email' ,@EshopEmails= 'EshopEmails' ,@IsBuyer= 0 ,@IsSupplier= 0 ,@Region= 'Region' ,@Country= 'Country' ,@IsCompetition= 0 ,@FileMarkText= 'FileMarkText' ,@IsWSInvoicesExportAllowed= 0 ,@IsWSDeliveryNotesExportAllowed= 0 ,@IsWSImportOrdersAllowed= 0 ,@StoreBackOrder= 0 ,@IsSupplierIndividualOrders= 0 ,@IsSupplierShortcut= 'IsSupplierShortcut' ,@Note= 'Note' ,@Note2= 'Note2' ,@GlobalPricing= 0 ,@OrderGroup= 'OrderGroup' ,@GPSLatitude= 'GPSLatitude' ,@GPSLongitude= 'GPSLongitude' ,@ParentID= -1, @VisibleProductsAmountOnStockLimit = 10, @AreOrdersVisible = 1, @DeliveryAddressID = -1, @DefaultPaymentType = 1, @DueType = 1, @DueDays = 0, @CorrectionPaymentType = 1, @CorrectionPaymentRange = 0, @CorrectionPaymentRangeDays = 0
</syntaxhighlight>

==== Notices ====
None.

API UpdateProductGroup

2020-08-13T08:37:25Z

Chrzaszcz:

==== Description ====
Method allows You to update product group in system.

==== Exact name ====
<code>API_UpdateProductGroup</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID
|int
|
|Internal system id
|API_GetProductGroups.ID
|-
|@ProductCode
|nvarchar(40)
|
|Product code
|
|-
|@TecDocCode
|nvarchar(35)
|
|TecDoc code
|
|-
|@TecDocBrandName
|nvarchar(80)
|
|TecDoc brand name
|
|-
|@TecDocBrandID
|int
|
|TecDoc brand ID
|
|-
|@GroupName
|nvarchar(100)
|
|Group name
|
|-
|@SubGoupName
|nvarchar(100)
|
|Sub goup name
|
|-
|@AssortmentName
|nvarchar(100)
|
|AssortmentName
|
|-
|@Name
|nvarchar(100)
|
|Name
|
|-
|@Name2
|nvarchar(150)
|
|Name2
|
|-
|@IsNew
|bit
|
|Is new:
0 = Off,

1 = On
|
|-
|@PurchasePrice
|decimal(19,6)
|
|Purchase price
|
|-
|@RetailPrice
|decimal(19,6)
|
|Retail price
|
|-
|@IsArchiving
|int
|
|Is archiving
|
|-
|@SupplierID
|int
|
|Supplier ID
|API_GetCustomers.ID
|-
|@Prefix
|nvarchar(3)
|
|@Prefix
|
|-
|@SupplierProductCode
|nvarchar(40)
|
|Supplier product code
|
|-
|@ManufacturerSupplier
|nvarchar(50)
|
|Manufacturer supplier
|
|-
|@SupplierItemName
|nvarchar(300)
|
|Supplier item name
|
|-
|@BasicPrice
|decimal(19,6)
|
|Basic price
|
|-
|@SupplierRetailPrice
|decimal(19,6)
|
|Supplier retail price
|
|-
|@SupplierIsArchiving
|int
|
|Supplier is archiving
|
|-
|@Description
|nvarchar(250)
|
|Description
|
|-
|@EshopDescription
|nvarchar(500)
|
|Eshop description
|
|-
|@VATRate
|int
|
|ID of VAT rates from VAT rates list (see relation)
|API_GetVATRates.ID
|-
|@MinimumOrderablePieces
|decimal(18,2)
|
|Minimum orderable pieces
|
|-
|@UnitID
|int
|
|ID of unit from units list (see relation)
|API_GetUnits.ID
|-
|@IsSale
|bit
|
|Is sale:
0 = Off,

1 = On
|
|-
|@IsHiddenOnEshop
|bit
|
|Is hidden on eshop:
0 = Off,

1 = On
|
|-
|@InfoReturnOfGoods
|nvarchar(50)
|
|Info return of goods
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID int
DECLARE @ProductCode nvarchar(40)
DECLARE @TecDocCode nvarchar(35)
DECLARE @TecDocBrandName nvarchar(80)
DECLARE @TecDocBrandID int
DECLARE @GroupName nvarchar(100)
DECLARE @SubGoupName nvarchar(100)
DECLARE @AssortmentName nvarchar(100)
DECLARE @Name nvarchar(100)
DECLARE @Name2 nvarchar(150)
DECLARE @IsNew bit
DECLARE @PurchasePrice decimal(19,6)
DECLARE @RetailPrice decimal(19,6)
DECLARE @IsArchiving int
DECLARE @SupplierID int
DECLARE @Prefix nvarchar(3)
DECLARE @SupplierProductCode nvarchar(40)
DECLARE @ManufacturerSupplier nvarchar(50)
DECLARE @SupplierItemName nvarchar(300)
DECLARE @BasicPrice decimal(19,6)
DECLARE @SupplierRetailPrice decimal(19,6)
DECLARE @SupplierIsArchiving int
DECLARE @Description nvarchar(250)
DECLARE @EshopDescription nvarchar(500)
DECLARE @VATRate int
DECLARE @MinimumOrderablePieces decimal(18,2)
DECLARE @UnitID int
DECLARE @IsSale bit
DECLARE @IsHiddenOnEshop bit
DECLARE @InfoReturnOfGoods nvarchar(50)

SELECT @ID = [ID],
@ProductCode = [ProductCode],
@TecDocCode = [TecDocCode],
@TecDocBrandName = [TecDocBrandName],
@TecDocBrandID = [TecDocBrandID],
@GroupName = [GroupName],
@SubGoupName = [SubGoupName],
@AssortmentName = [AssortmentName],
@Name = 'Name 2',
@Name2 = [Name2],
@IsNew = [IsNew],
@PurchasePrice = [PurchasePrice],
@RetailPrice = [RetailPrice],
@Description = [Description],
@EshopDescription = [EshopDescription],
@VATRate = [VATRate],
@MinimumOrderablePieces = [MinimumOrderablePieces],
@UnitID = [UnitID],
@IsArchiving = [IsArchiving],
@IsSale = [IsSale],
@IsHiddenOnEshop = [IsHiddenOnEshop]
FROM [API_GetProductGroups]
WHERE id = 3

SELECT @SupplierID = [SupplierID],
@Prefix = [Prefix],
@SupplierProductCode = [SupplierProductCode],
@ManufacturerSupplier = [ManufacturerSupplier],
@SupplierItemName = [SupplierItemName],
@BasicPrice = [BasicPrice],
@SupplierRetailPrice = [RetailPrice],
@SupplierIsArchiving = [IsArchiving],
@InfoReturnOfGoods = [InfoReturnOfGoods]
FROM [API_GetProducts]
WHERE GroupID = @ID and SupplierID = @SupplierID

EXECUTE @return_value = [API_UpdateProductGroup]
@ID,
@ProductCode,
@TecDocCode,
@TecDocBrandName,
@TecDocBrandID,
@GroupName,
@SubGoupName,
@AssortmentName,
@Name,
@Name2,
@IsNew,
@PurchasePrice,
@RetailPrice,
@IsArchiving,
@SupplierID,
@Prefix,
@SupplierProductCode,
@ManufacturerSupplier,
@SupplierItemName,
@BasicPrice,
@SupplierRetailPrice,
@SupplierIsArchiving,
@Description,
@EshopDescription,
@VATRate,
@MinimumOrderablePieces,
@UnitID,
@IsSale,
@IsHiddenOnEshop,
@InfoReturnOfGoods

</syntaxhighlight>

==== Notices ====
None.

API UpdateProduct

2020-08-13T08:32:14Z

Chrzaszcz:

==== Description ====
Method allows You to update product in system.

==== Exact name ====
<code>API_UpdateProduct</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ID3
|int
|
|Internal system id
|API_GetProducts.ID
|-
|@SupplierID
|int
|
|Supplier ID
|API_GetCustomers.ID
|-
|@GroupID
|int
|
|Group ID
|API_GetProductGroups.ID
|-
|@SupplierProductCode
|nvarchar(40)
|
|Supplier product code
|
|-
|@ManufacturerSupplier
|nvarchar(50)
|
|Manufacturer supplier
|
|-
|@Prefix
|nvarchar(3)
|
|Prefix
|
|-
|@SupplierItemName
|nvarchar(150)
|
|Supplier item name
|
|-
|@MinimumOrderableQuantity
|decimal(18,2)
|
|Minimum orderable quantity
|
|-
|@SupplierIsArchiving
|int
|
|Supplier is archiving
|
|-
|@ForeignPrice
|decimal(19,6)
|
|Foreign price
|
|-
|@BasicPrice
|decimal(18,6)
|
|Basic price
|
|-
|@InfoReturnOfGoods
|nvarchar(50)
|
|Info return of goods
|
|}

==== Return ====
0 : OK
100 : Item could not be updated

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
DECLARE @ID3 int
DECLARE @SupplierID int
DECLARE @GroupID int
DECLARE @SupplierProductCode nvarchar(40)
DECLARE @ManufacturerSupplier nvarchar(50)
DECLARE @Prefix nvarchar(3)
DECLARE @SupplierItemName nvarchar(150)
DECLARE @MinimumOrderableQuantity decimal(18,2)
DECLARE @SupplierIsArchiving int
DECLARE @ForeignPrice decimal(19,6)
DECLARE @BasicPrice decimal(19,6)
DECLARE @InfoReturnOfGoods nvarchar(50)

SELECT @ID3 = [ID],
@SupplierID = [SupplierID],
@GroupID = [GroupID],
@SupplierProductCode = [SupplierProductCode],
@ManufacturerSupplier = [ManufacturerSupplier],
@Prefix = [Prefix],
@SupplierItemName = [SupplierItemName],
@MinimumOrderableQuantity = [MinimumOrderableQuantity],
@SupplierIsArchiving = [IsArchiving]
@ForeignPrice = [ForeignPrice],
@BasicPrice = 200,
@InfoReturnOfGoods = [InfoReturnOfGoods]
FROM [API_GetProducts]
WHERE id = 3

EXECUTE @return_value = [API_UpdateProduct]
@ID3,
@SupplierID,
@GroupID,
@SupplierProductCode,
@ManufacturerSupplier,
@Prefix,
@SupplierItemName,
@MinimumOrderableQuantity,
@SupplierIsArchiving,
@ForeignPrice,
@BasicPrice
@InfoReturnOfGoods

</syntaxhighlight>

==== Notices ====
None.

API CreateProductGroup

2020-08-13T08:28:40Z

Chrzaszcz:

==== Description ====
Method allows You to create new product group in system.

==== Exact name ====
<code>API_CreateProductGroup</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@ProductCode
|nvarchar(40)
|
|Product code
|
|-
|@TecDocCode
|nvarchar(35)
|
|TecDoc code
|
|-
|@TecDocBrandName
|nvarchar(80)
|
|TecDoc brand name
|
|-
|@TecDocBrandID
|int
|
|TecDoc brand ID
|
|-
|@GroupName
|nvarchar(100)
|
|Group name
|
|-
|@SubGoupName
|nvarchar(100)
|
|Sub goup name
|
|-
|@AssortmentName
|nvarchar(100)
|
|AssortmentName
|
|-
|@Name
|nvarchar(100)
|
|Name
|
|-
|@Name2
|nvarchar(150)
|
|Name 2
|
|-
|@IsNew
|int
|
|Is new:
0 = Off,

1 = On
|
|-
|@PurchasePrice
|decimal(18,6)
|
|Purchase price
|
|-
|@RetailPrice
|decimal(18,6)
|
|Retail price
|
|-
|@SupplierID
|int
|
|Supplier ID
|API_GetCustomers.ID
|-
|@Prefix
|nvarchar(3)
|
|Prefix
|
|-
|@SupplierProductCode
|nvarchar(40)
|
|Supplier product code
|
|-
|@ManufacturerSupplier
|nvarchar(50)
|
|Manufacturer supplier
|
|-
|@SupplierItemName
|nvarchar(300)
|
|Supplier item name
|
|-
|@BasicPrice
|decimal(19,6)
|
|Basic price
|
|-
|@SupplierRetailPrice
|decimal(19,6)
|
|Supplier retail price
|
|-
|@Description
|nvarchar(250)
|
|Description
|
|-
|@EshopDescription
|nvarchar(500)
|
|Eshop description
|
|-
|@VATRate
|int
|
|ID of VAT rates from VAT rates list (see relation)
|API_GetVATRates.ID
|-
|@MinimumOrderablePieces
|decimal(18,2)
|
|Minimum orderable pieces
|
|-
|@UnitID
|int
|
|ID of unit from units list (see relation)
|API_GetUnits.ID
|-
|@IsSale
|bit
|
|Is sale:
0 = Off,

1 = On
|
|-
|@IsHiddenOnEshop
|bit
|
|Is hidden on eshop:
0 = Off,

1 = On
|
|-
|@InfoReturnOfGoods
|nvarchar(50)
|
|Info return of goods
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateProductGroup] @ProductCode= '1457429619' ,@TecDocCode= '1 457 429 619' ,@TecDocBrandName= 'BOSCH' ,@TecDocBrandID= 30 ,@GroupName= 'GroupName' ,@SubGoupName= 'SubGoupName' ,@AssortmentName= 'AssortmentName' ,@Name= 'Name' ,@Name2= 'Name2' ,@IsNew= 0 ,@PurchasePrice= 100 ,@RetailPrice= 190 ,@SupplierID= 2 ,@Prefix= '' ,@SupplierProductCode= '1457429619BS' ,@ManufacturerSupplier= 'BOSCH2' ,@SupplierItemName= 'SupplierItemName' ,@BasicPrice= 100 ,@SupplierRetailPrice= 220 ,@Description= 'Description' ,@EshopDescription= 'EshopDescription' ,@VATRate = 16028 ,@MinimumOrderablePieces= 1 ,@UnitID= 148, @IsSale= 0, @IsHiddenOnEshop = 0, @InfoReturnOfGoods = ''
</syntaxhighlight>

==== Notices ====
None.

API GetProducts

2020-08-13T08:26:03Z

Chrzaszcz:

==== Description ====
Method gives You overview of existing products in system.

==== Exact name ====
<code>API_GetProducts</code>

==== Type ====
Standard view.

==== Specification ====
{| class="wikitable"
!Column
!Data type
!Description
!Relation
|-
|ID
|int
|Internal system id
|
|-
|GroupID
|int
|
|API_GetProductGroups.ID
|-
|SupplierID
|int
|SupplierID
|API_GetCustomers.ID
|-
|ProductCode
|nvarchar(40)
|Product code
|
|-
|TypeID
|int
|TypeID.
1 - products
|
|-
|MinimumOrderableQuantity
|decimal(18,2)
|Minimum orderable quantity
|
|-
|BasicPrice
|decimal(18,6)
|Basic price
|
|-
|CreatedDate
|datetime
|Created date
|
|-
|UpdatedDate
|datetime
|Updated date
|
|-
|SupplierItemName
|nvarchar(150)
|Supplier item name
|
|-
|SupplierProductCode
|nvarchar(40)
|Supplier product code
|
|-
|Prefix
|nvarchar(3)
|Prefix
|
|-
|ManufacturerSupplier
|nvarchar(50)
|Manufacturer supplier
|
|-
|ForeignPrice
|decimal(19,6)
|Foreign price
|
|-
|RetailPrice
|decimal(18,6)
|Retail price
|
|-
|IsArchiving
|int
|Is archiving
|
|-
|ArchivingDate
|datetime
|Archiving date
|
|-
|InfoReturnOfGoods
|nvarchar(50)
|Info return of goods
|
|}

==== Example ====
<syntaxhighlight lang="sql">
SELECT TOP 1000 * FROM [API_GetProducts]
</syntaxhighlight>

==== Notices ====
None.

API CreateProduct

2020-08-13T08:24:04Z

Chrzaszcz:

==== Description ====
Method allows You to create new product in system.

==== Exact name ====
<code>API_CreateProduct</code>

==== Type ====
Standard executable stored procedure.

==== Specification ====
{| class="wikitable"
!Parameter
!Data type
!Value range
!Description
!Relation
|-
|@SupplierID
|int
|
|Supplier ID
|API_GetCustomers.ID
|-
|@GroupID
|int
|
|Group ID
|API_GetProductGroups.ID
|-
|@SupplierProductCode
|nvarchar(40)
|
|Supplier product code
|
|-
|@ManufacturerSupplier
|nvarchar(50)
|
|Manufacturer supplier
|
|-
|@Prefix
|nvarchar(3)
|
|Prefix
|
|-
|@SupplierItemName
|nvarchar(150)
|
|Supplier item name
|
|-
|@MinimumOrderableQuantity
|decimal(18,2)
|
|Minimum orderable quantity
|
|-
|@ForeignPrice
|decimal(19,6)
|
|Foreign price
|
|-
|@BasicPrice
|decimal(18,6)
|
|Basic price
|
|-
|@InfoReturnOfGoods
|nvarchar(50)
|
|Info return of goods
|
|}

==== Return ====
0 : OK
100 : Item could not be created

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
EXEC @return_value = [API_CreateProduct] @SupplierID= 2 ,@GroupID= 14 ,@SupplierProductCode= '1457429619BS' ,@ManufacturerSupplier= 'BOSCH2' ,@Prefix= '' ,@SupplierItemName= 'SupplierItemName' ,@MinimumOrderableQuantity= 1 ,@ForeignPrice= 110 ,@BasicPrice= 190, @InfoReturnOfGoods=''
</syntaxhighlight>

==== Notices ====
None.

API ProductGroups BULK

2020-08-13T07:59:51Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to update and create new product groups in system. ==== Exact name ==== <code>API_ProductGroups_BULK</code> ====…“

==== Description ====
Method allows You to update and create new product groups in system.

==== Exact name ====
<code>API_ProductGroups_BULK</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Table-Valued Parameters Specification ====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProductCode
|nvarchar(40)
|
|Product code
|
|-
|TecDocCode
|nvarchar(35)
|
|TecDoc code
|
|-
|TecDocBrandName
|nvarchar(80)
|
|TecDoc brand name
|
|-
|TecDocBrandID
|int
|
|TecDoc brand ID
|
|-
|GroupName
|nvarchar(100)
|
|Group name
|
|-
|SubGoupName
|nvarchar(100)
|
|Sub goup name
|
|-
|AssortmentName
|nvarchar(100)
|
|AssortmentName
|
|-
|Name
|nvarchar(100)
|
|Name
|
|-
|Name2
|nvarchar(150)
|
|Name 2
|
|-
|IsNew
|bit
|
|Is new:
0 = Off,

1 = On
|
|-
|PurchasePrice
|decimal(18,6)
|
|Purchase price
|
|-
|RetailPrice
|decimal(18,6)
|
|Retail price
|
|-
|SupplierID
|int
|
|Supplier ID
|API_GetCustomers.ID
|-
|Prefix
|nvarchar(3)
|
|Prefix
|
|-
|SupplierProductCode
|nvarchar(40)
|
|Supplier product code
|
|-
|ManufacturerSupplier
|nvarchar(50)
|
|Manufacturer supplier
|
|-
|SupplierItemName
|nvarchar(300)
|
|Supplier item name
|
|-
|BasicPrice
|decimal(19,6)
|
|Basic price
|
|-
|SupplierRetailPrice
|decimal(19,6)
|
|Supplier retail price
|
|-
|Description
|nvarchar(250)
|
|Description
|
|-
|EshopDescription
|nvarchar(500)
|
|Eshop description
|
|-
|VATRate
|int
|
|ID of VAT rates from VAT rates list (see relation)
|API_GetVATRates.ID
|-
|MinimumOrderablePieces
|decimal(18,2)
|
|Minimum orderable pieces
|
|-
|UnitID
|int
|
|ID of unit from units list (see relation)
|API_GetUnits.ID
|-
|IsSale
|bit
|
|Is sale:
0 = Off,

1 = On
|
|-
|IsHiddenOnEshop
|bit
|
|Is hidden on eshop:
0 = Off,

1 = On
|

|-
|InfoReturnOfGoods
|nvarchar(50)
|
|Info return of goods
|
|-
|ID
|int
|
|Internal system id. If you create it, set it to null
|API_GetProductGroups.ID
|-
|IsArchiving
|int
|
|Is archiving. If you create it, set it to null
|
|-
|SupplierIsArchiving
|int
|
|Supplier is archiving. If you create it, set it to null
|
|}

==== Return ====
0 : OK
100 : Error

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @ProductGroups dbo.APIsProductGroups
INSERT INTO @ProductGroups
SELECT G.[ProductCode],
G.[TecDocCode],
G.[TecDocBrandName],
G.[TecDocBrandID],
G.[GroupName],
G.[SubGoupName],
G.[AssortmentName],
G.[Name],
G.[Name2],
1, --G.[IsNew],
G.[PurchasePrice],
G.[RetailPrice],
P.[SupplierID],
P.[Prefix],
P.[SupplierProductCode],
P.[ManufacturerSupplier],
P.[SupplierItemName],
P.[BasicPrice],
P.[RetailPrice],
G.[Description],
G.[EshopDescription],
G.[VATRate],
G.[MinimumOrderablePieces],
G.[UnitID],
G.[IsSale],
G.[IsHiddenOnEshop],
P.[InfoReturnOfGoods],
G.[ID],
G.[IsArchiving],
P.[IsArchiving]
FROM [API_GetProductGroups] G
LEFT JOIN [API_GetProducts] P ON G.ID = P.GroupID
WHERE G.ID in (7,9)
union
SELECT '1457429619', '1 457 429 619', 'BOSCH', 30, 'BOSCH', null, null, 'Name', '', 1, 100, 190, 7, '', '1457429619BOS', 'BOSCH', '', 100, 220, '', '', 16028, 1, 148, 0, 0, '', null, 0, 0

exec @return_value = dbo.[API_ProductGroups_BULK] @ProductGroups
</syntaxhighlight>

==== Notices ====
API_ProductGroups_BULK procedure uses own data type called ProductGroups (dbo.APIsProductGroups).

API EN DATA METHOD DESC

2020-08-13T07:59:22Z

Chrzaszcz:

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[Send Order]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroups_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API ProductGroup BULK

2020-08-13T07:56:42Z

Chrzaszcz:

API EN DATA METHOD DESC

2020-08-12T14:54:12Z

Chrzaszcz:

=== Main informations ===
Provider
* [[API_GetProviderInformations]]
* [[API_UpdateProviderInformations]]

==== Branches ====
Provides functionality to manage branches within your company. Minimum count of branches is 1 and maximum is not specified (there's no limitation).
* [[API_CreateBranch]]
Method allows You to create new branch in system
* [[API_GetBranches]]
Method gives You overview of existing branches in system
* [[API_RemoveBranch]]
Method allows You to delete specific branch (branches)
* [[API_UpdateBranch]]
Method allows You to change (update) branch informations

==== Stocks (warehouses) ====
* [[API_CreateStock]]
* [[API_GetStocks]]
* [[API_RemoveStock]]
* [[API_UpdateStock]]

==== Workshops ====
* [[API_CreateWorkshop]]
* [[API_GetWorkshops]]
* [[API_RemoveWorkshop]]
* [[API_UpdateWorkshop]]

=== User interface ===

==== Custom Menu ====
* [[API_CreateCustomMenuCategory]]
* [[API_GetCustomMenuCategory]]
* [[API_RemoveCustomMenuCategoryAndSubcategories]]
* [[API_UpdateCustomMenuCategory]]

==== Articles ====
* [[API_CreateArticle]]
* [[API_GetArticles]]
* [[API_RemoveArticle]]
* [[API_UpdateArticle]]

==== Recommended links ====
* [[API_CreateRecommendedLink]]
* [[API_GetRecommendedLinks]]
* [[API_RemoveRecommendedLink]]
* [[API_UpdateRecommendedLink]]

==== Selected categories ====
* [[API_CreateSelectedCategory]]
* [[API_GetSelectedCategories]]
* [[API_RemoveSelectedCategory]]
* [[API_UpdateSelectedCategory]]

==== Download files ====
* [[API_CreateDownloadFile]]
* [[API_GetDownloadFiles]]
* [[API_RemoveDownloadFile]]
* [[API_UpdateDownloadFile]]

==== Universal parts category ====
* [[API_CreateUniversalPartsCategory]]
* [[API_GetUniversalPartsCategories]]
* [[API_RemoveUniversalPartsCategoryAndSubcategories]]
* [[API_UpdateUniversalPartsCategory]]
* [[API_CreateUniversalPartsCategoryConnection]]
* [[API_GetUniversalPartsCategoryConnection]]
* [[API_RemoveUniversalPartsCategoryConnectionGroup]]
* [[API_RemoveUniversalPartsCategoryConnection]]
* [[API_UpdateUniversalPartsCategoryConnection]]

==== Newsletter ====
* [[API_CreateNewsletterEmailAddresses]]
* [[API_GetNewsletterEmailAddresses]]
* [[API_RemoveNewsletterEmailAddresses]]
* [[API_UpdateNewsletterEmailAddresses]]

=== Basket operations ===
* [[API_CreateBasketItem]]
* [[API_GetBasketItems]]
* [[API_RemoveBasket]]
* [[API_RemoveBasketItem]]
* [[API_UpdateBasketItem]]

=== Customer operations ===
* [[API_CreateCustomer]]
* [[API_GetCustomers]]
* [[API_RemoveCustomer]]
* [[API_UpdateCustomer]]
* [[API_GetCustomerSettings]]
* [[API_UpdateCustomerSettings]]
* [[API_CreateCustomerBranches]]
* [[API_UpdateCustomerBranches]]

=== Documents operations ===

==== Invoices ====
* [[API_CreateInvoice]]
* [[API_GetInvoices]]
* [[API_GetDocumentVAT]]
* [[API_RemoveInvoice]]
* [[API_UpdateInvoice]]

==== Delivery notes ====
* [[API_CreateDeliveryNote]]
* [[API_GetDeliveryNote]]
* [[API_RemoveDeliveryNote]]
* [[API_UpdateDeliveryNote]]

==== Document items ====
* [[API_CreateDocumentItem]]
* [[API_GetDocumentItems]]
* [[API_RemoveDocumentItem]]
* [[API_UpdateDocumentItem]]

==== Orders ====
* [[API_GetOrderDetail]]
* [[API_GetOrders]]
* [[API_UpdateOrders]]
* [[Send Order]]

=== Catalog items ===

==== Product list ====

==== Sorting groups operations ====
* [[API_CreateProductGroup]]
* [[API_GetProductGroups]]
* [[API_RemoveProductGroups]]
* [[API_UpdateProductGroup]]
* [[API_ProductGroup_BULK]]

===== Item level operations =====
* [[API_CreateProduct]]
* [[API_GetProducts]]
* [[API_RemoveProduct]]
* [[API_UpdateProduct]]
* [[API_Products_BULK]]

==== Warehouse availability ====
* [[API_CreateStockDispositions]]
* [[API_GetStockDispositions]]
* [[API_RemoveStockDispositions]]
* [[API_UpdateStockDispositions]]

==== Brands (list of brands) ====
* [[API_CreateTECDOC_Brands]]
* [[API_GetTecDocBrands]]
* [[API_RemoveTECDOC_Brands]]
* [[API_UpdateTECDOC_Brands]]

==== Prices ====
* [[API_GetPrices]]

==== Replacements ====
* [[API_CreateProductReplacements]]
* [[API_GetProductReplacements]]
* [[API_RemoveProductReplacements]]
* [[API_UpdateProductReplacements]]

==== OEM - Original Equipment Manufacturer ====
* [[API_CreateProductOEM]]
* [[API_GetProductOEM]]
* [[API_RemoveProductOEM]]

==== Translator ====
* [[API_CreateTranslator]]
* [[API_GetTranslator]]
* [[API_RemoveTranslator]]
* [[API_UpdateTranslator]]

==== Crosses====
* [[API_GetLaximoBrands]]
* [[API_CreateCrossNumbers]]
* [[API_GetCrossNumbers]]
* [[API_UpdateCrossNumbers]]
* [[API_RemoveCrossNumbers]]

==== Product service====
* [[API_GetProductService]]
* [[API_CreateProductService]]
* [[API_UpdateProductService]]
* [[API_RemoveProductService]]

==== EAN - European Article Number ====
* [[API_CreateProductEAN]]
* [[API_GetProductEAN]]
* [[API_RemoveProductEAN]]

=== Configuration ===

==== Transportation ====
* [[API_CreateTransport]]
* [[API_GetTransports]]
* [[API_UpdateTransport]]

==== Countries ====
* [[API_CreateCountry]]
* [[API_GetCountry]]

==== Currencies ====
* [[API_CreateCurrency]]
* [[API_GetCurrency]]

==== Units ====
* [[API_CreateUnit]]
* [[API_GetUnits]]

==== VAT rates ====
* [[API_CreateVATRate]]
* [[API_GetVATRates]]
* [[API_UpdateVATRate]]

=== WMS ===
* [[API_WMS_TerminalExpeditionOverview]]
* [[API_WMS_TerminalOrderPickingOverview]]
* [[API_WMS_WarehouseInternalMovements]]
* [[API_WMS_GetWarehousePositions]]

=== Payments ===
* [[API_CreatePayment]]
* [[API_GetPayments]]
* [[API_UpdatePayment]]

=== GDPR ===
* [[API_GetPrivacyConsents]]

API ProductGroup BULK

2020-08-12T14:52:09Z

Chrzaszcz: Založena nová stránka s textem „==== Description ==== Method allows You to update and create new product group in system. ==== Exact name ==== <code>API_ProductGroup_BULK</code> ==== Ty…“

==== Description ====
Method allows You to update and create new product group in system.

==== Exact name ====
<code>API_ProductGroup_BULK</code>

==== Type ====
Standard executable stored procedure with table-Valued Parameters.

==== Table-Valued Parameters Specification ====
{| class="wikitable"
!Columns name
!Data type
!Value range
!Description
!Relation
|-
|ProductCode
|nvarchar(40)
|
|Product code
|
|-
|TecDocCode
|nvarchar(35)
|
|TecDoc code
|
|-
|TecDocBrandName
|nvarchar(80)
|
|TecDoc brand name
|
|-
|TecDocBrandID
|int
|
|TecDoc brand ID
|
|-
|GroupName
|nvarchar(100)
|
|Group name
|
|-
|SubGoupName
|nvarchar(100)
|
|Sub goup name
|
|-
|AssortmentName
|nvarchar(100)
|
|AssortmentName
|
|-
|Name
|nvarchar(100)
|
|Name
|
|-
|Name2
|nvarchar(150)
|
|Name 2
|
|-
|IsNew
|bit
|
|Is new:
0 = Off,

1 = On
|
|-
|PurchasePrice
|decimal(18,6)
|
|Purchase price
|
|-
|RetailPrice
|decimal(18,6)
|
|Retail price
|
|-
|SupplierID
|int
|
|Supplier ID
|API_GetCustomers.ID
|-
|Prefix
|nvarchar(3)
|
|Prefix
|
|-
|SupplierProductCode
|nvarchar(40)
|
|Supplier product code
|
|-
|ManufacturerSupplier
|nvarchar(50)
|
|Manufacturer supplier
|
|-
|SupplierItemName
|nvarchar(300)
|
|Supplier item name
|
|-
|BasicPrice
|decimal(19,6)
|
|Basic price
|
|-
|SupplierRetailPrice
|decimal(19,6)
|
|Supplier retail price
|
|-
|Description
|nvarchar(250)
|
|Description
|
|-
|EshopDescription
|nvarchar(500)
|
|Eshop description
|
|-
|VATRate
|int
|
|ID of VAT rates from VAT rates list (see relation)
|API_GetVATRates.ID
|-
|MinimumOrderablePieces
|decimal(18,2)
|
|Minimum orderable pieces
|
|-
|UnitID
|int
|
|ID of unit from units list (see relation)
|API_GetUnits.ID
|-
|IsSale
|bit
|
|Is sale:
0 = Off,

1 = On
|
|-
|IsHiddenOnEshop
|bit
|
|Is hidden on eshop:
0 = Off,

1 = On
|

|-
|InfoReturnOfGoods
|nvarchar(50)
|
|Info return of goods
|
|-
|ID
|int
|
|Internal system id. If you create it, set it to null
|API_GetProductGroups.ID
|-
|IsArchiving
|int
|
|Is archiving. If you create it, set it to null
|
|-
|SupplierIsArchiving
|int
|
|Supplier is archiving. If you create it, set it to null
|
|}

==== Return ====
0 : OK
100 : Error

==== Example ====
<syntaxhighlight lang="sql">
DECLARE @return_value int
Declare @ProductGrup dbo.APIsProductGroup
INSERT INTO @ProductGrup
SELECT G.[ProductCode],
G.[TecDocCode],
G.[TecDocBrandName],
G.[TecDocBrandID],
G.[GroupName],
G.[SubGoupName],
G.[AssortmentName],
G.[Name],
G.[Name2],
1, --G.[IsNew],
G.[PurchasePrice],
G.[RetailPrice],
P.[SupplierID],
P.[Prefix],
P.[SupplierProductCode],
P.[ManufacturerSupplier],
P.[SupplierItemName],
P.[BasicPrice],
P.[RetailPrice],
G.[Description],
G.[EshopDescription],
G.[VATRate],
G.[MinimumOrderablePieces],
G.[UnitID],
G.[IsSale],
G.[IsHiddenOnEshop],
P.[InfoReturnOfGoods],
G.[ID],
G.[IsArchiving],
P.[IsArchiving]
FROM [API_GetProductGroups] G
LEFT JOIN [API_GetProducts] P ON G.ID = P.GroupID
WHERE G.ID in (7,9)
union
SELECT '1457429619', '1 457 429 619', 'BOSCH', 30, 'BOSCH', null, null, 'Name', '', 1, 100, 190, 7, '', '1457429619BOS', 'BOSCH', '', 100, 220, '', '', 16028, 1, 148, 0, 0, '', null, 0, 0

exec @return_value = dbo.[API_ProductGroup_BULK] @ProductGrup
</syntaxhighlight>

==== Notices ====
API_ProductGroup_BULK procedure uses own data type called ProductGrup (dbo.APIsProductGroup).