Пример 31. Описание на Login web service
Name: erpSOAPServer..Login Binding: erpserverBinding Endpoint: https://dev.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPServer..Login Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPServer..LoginRequest parts: username: xsd:string password: xsd:string cnum: xsd:string db: xsd:string Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPServer..LoginResponse parts: return: xsd:decimal Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation:
Параметри:
username - Потребителско име, тип: низ;
password - Парола на потребителя, тип: низ;
cnum - Клиентски номер, тип: низ;
db - База данни, към която ще се вписва потребителя, тип: низ.
Резултат:
return - Успешен/Неуспешен вход, тип: реално число.
Пример 32. Описание на Login by PAP web service
Name: erpSOAPServer..LoginByPAP Binding: erpserverBinding Endpoint: https://dev3.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPServer..LoginByPAP Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPServer..LoginByPAPRequest parts: PAPID: xsd:string username: xsd:string password: xsd:string Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPServer..LoginByPAPResponse parts: return: xsd:decimal Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation:
Параметри:
PAPID - PAPID на базата данни, тип: низ;
username - Потребителско име, тип: низ;
username - Парола на потребителя, тип: низ.
Резултат:
return - Успешен/Неуспешен вход, тип: реално число.
Пример 33. Описание на Logout web service
Name: erpSOAPServer..Logout Binding: erpserverBinding Endpoint: https://dev.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPServer..Logout Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPServer..LogoutRequest parts: Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPServer..LogoutResponse parts: return: xsd:decimal Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation:
Параметри:
N/A - няма;
Резултат:
return - Успешен/Неуспешен изход, тип: реално число.
Връща списък с артикули за група GNum и с номера между FromMNum и ToMNum.
Пример 34. Описание на GetMats web service
Name: erpSOAPSell..GetMats Binding: erpserverBinding Endpoint: https://dev.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPSell..GetMats Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPSell..GetMatsRequest parts: FromMNum: xsd:string ToMNum: xsd:string GNum: xsd:string mAttributeCategory: tns:stringArray PriceLevel: xsd:string curCode: xsd:string Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPSell..GetMatsResponse parts: return: tns:matInfoArray Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation: Returns list of materials for GNum and between FromMNum and ToMNum
Параметри:
FromMNum, ToMNum - диапазон от номера на асортименти. Ако се пропуснат се приема без ограничение по диапазон на номера;
GNum - номер на група асортименти. Ако е зададена стойност ще в резултата ще се включат асортиментите от тази група само;
mAttributeCategory - списък от кодове на категории атрибути. Ако има зададени такива, в резултата ще се включат и стойностите на атрибутите в тези категории;
PriceLevel - ценово ниво за което да се върнат цените (1-10). Ако е 0 крайни цени;
curCode - ценово ниво за което да се върнат цените (1-10). Ако е 0 крайни цени.
Резултат - списък от активни асортименти по зададените ограничения със следната структура.
idMat - уникален идентификатор на асортимента, който не може да бъде променен;
MNum - номер на асортимента (продуктов код);
MName - име на асортимента;
ProdName - име на производителя;
MKCode - вид на асортимента. 'СТО' - стоки, 'МАТ' - материали, 'УСЛ' - услуги;
MUnit - мерна единица;
idGroup - вътрешен идентификатор на групата, към която принадлежи асортимента;
GNum - номер на групата към която принадлежи асортимента;
PackSchemeName - наименование на схема на опаковане/разфасоване;
Price - ефективна цена за зададеното ценово ниво PriceLevel;
curCode - валута, в която е представена цената. Ако е зададен параметър curCode, всички цени ще бъдат в тази валута;
matAttribute - списък от атрибути и техните стойности по заявените категории в mAttributeCategory. idAttribute - идентификатор на атрибута, attribCode - код на атрибута, attribValue - стойност на атрибута.
Връща списък от активни асортименти, информация за наличности и цени в зависимост от подадените параметри.
Пример 35. Описание на GetMatsAvP web service
Name: erpSOAPStore..GetMatsAvP Binding: erpserverBinding Endpoint: https://erp01.edabg.com:443/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPStore..GetMatsAvP Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPStore..GetMatsAvPRequest parts: FromMNum: xsd:string ToMNum: xsd:string MName: xsd:string PNum: xsd:string Stores: tns:stringArray MGroups: tns:stringArray priceLevel: xsd:string curCode: xsd:string attribCodes: tns:stringArray attribValues: tns:attrValueArray getTags: xsd:integer onStockOnly: xsd:integer limit: tns:limitResult Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPStore..GetMatsAvPResponse parts: return: tns:matInfoArray Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation: Returns list of mats filtered (from FromMNum to ToMNum) and (like MName) and belonging to MGroups with price for priceLevel or PNum partner in curCode currency and with quantities in Stores
Параметри:
FromMNum, ToMNum - диапазон от номера на асортименти. Ако се пропуснат се приема без ограничение по диапазон на номера;
MName - ограничение по име на асортимент. В името могат да се използват символите '%' и '_' за замяна на произволни символи;
MGroups - списък от номера на групи асортименти, които да се включат в резултата;
PNum - номер на клиент, за който да се изчислят продажните цени. Ако не е посочен се изчисляват по priceLevel;
priceLevel - ценово ниво по което да се изчислят цените. Ако стойността е > 0 не се изчисляват цени за партньор;
curCode - вид валута, в която ще бъдат изчислени цените;
Stores - списък от номера на складове, в които да се върнат наличностите;
onStockOnly - стойност 0 или 1. 1 - включване само на наличните стоки в Stores. 0 - включване на всички стоки, независимо от наличностите;
attribCodes - списък от кодове на атрибути във формат 'категория_код.атрибут_код', които да се включат в резултата;
attribValues - списък от стойности на атрибути, по които да бъде ограничен резултата. Списъкът е със следната информация:
- attribCode - код на атрибута във формат 'категория_код.атрибут_код';
- attribValue - стойност на атрибута;
getTags - указва дали да се включат маркерите на асортиментите в резултата;
active - кои артилкули да се включат в избора - активни/неактивни: active = -1 - връща всички активни и неактивни, active = 1 - връща активните, active = 0 - връща неактивните;
limit - запис за ограничаване на резултата (използва се за сегментиране на резултата):
- from - отместване;
- count - брой записи;
- За получаване на общия брой записи в резултата, може да се използва метода erpSOAPServer..lastRowCount.
Резултат - списък от активни асортименти по зададените ограничения със следната структура.
idMat - уникален идентификатор на асортимента, който не може да бъде променен;
MNum - номер на асортимента (продуктов код);
MName - име на асортимента;
barCode - баркод на асортимента (EAN);
ProdName - име на производителя;
MKCode - вид на асортимента - 'СТО' - стоки, 'МАТ' - материали, 'УСЛ' - услуги;
MUnit - мерна единица;
MDDSTax - % ДДС;
idGroup - вътрешен идентификатор на групата, към която принадлежи асортимента;
Price - ефективна цена за зададеното ценово ниво PriceLevel;
GNum - номер на групата към която принадлежи асортимента;
PackSchemeName - наименование на схема на опаковане/разфасоване;
Price - ефективна цена за зададеното ценово ниво PriceLevel;
curCode - валута, в която е представена цената. Ако е зададен параметър curCode, всички цени ще бъдат в тази валута;
matAttribute - списък от атрибути и техните стойности по заявените категории в mAttributeCategory:
- idAttribute - идентификатор на атрибута;
- attribCode - код на атрибута;
- attribValue - стойност на атрибута.
matStore - списък от складове и наличности:
- SNum - вътрешен идентификатор на склада;
- AvQ - налично количества;
- QtyReservedSoft - количество 'слабо' резервирани;
- QtyReservedHard - количество 'твърдо' резервирани.
tags - списък от маркери:
- domainCode - код на група/домеин на маркиране;
- domain - име на домейн;
- tagCode - код на маркер;
- tag - име на маркер.
Връща наличното количество за артикул номер MNum от склад Snumber.
Пример 36. Описание на GetAvQ web service
Name: erpSOAPStore..GetAvQ Binding: erpserverBinding Endpoint: https://dev.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPStore..GetAvQ Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPStore..GetAvQRequest parts: SNumber: xsd:string MNum: xsd:string Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPStore..GetAvQResponse parts: return: tns:storeMatInfo Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation: Returns Quantity available of stock MNum in store Snumber
Параметри:
SNumber - Номер на склад, тип: низ;
MNum - Номер на артикул, тип: низ;
Резултат - Връща наличното количество за дадения артикул в избрания склад.
MatInfo - Информация за артикула, тип: масив:
- idMat - уникален идентификатор на асортимента, който не може да бъде променен, тип: реално число;
- MNum - номер на асортимента (продуктов код), тип: низ;
- MName - име на асортимента, тип: низ;
- MUnit - мерна единица, тип: низ;
- MKCode - вид на асортимента; 'СТО' - стоки, 'МАТ' - материали, 'УСЛ' - услуги; тип: низ;
- MDDSTax - % ДДС, тип: реално число;
- idGroup - вътрешен идентификатор на групата, към която принадлежи асортимента; тип: реално число;
- GNum - номер на групата към която принадлежи асортимента, тип: низ;
- PackSchemeName - наименование на схема на опаковане/разфасоване, тип: низ;
SNumber - Номер на склад, тип: низ;
AvQ - Налично количество, тип: число с плаваща запетая;
QtyReservedSoft - Резервирано обикновено количество, тип: число с плаваща запетая;
QtyReservedHard - Резервирано твърдо количество, тип: число с плаваща запетая.
Връща информация за активните резервации.
Пример 37. Описание на GetReservations web service
Name: erpSOAPStore..GetReservations Binding: erpserverBinding Endpoint: https://erp01.edabg.com:443/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPStore..GetReservations Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPStore..GetReservationsRequest parts: SNumber: xsd:string MNumA: tns:stringArray Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPStore..GetReservationsResponse parts: return: tns:reservInfoArray Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation: Returns reservations of stocks MNumA in store SNumber
Входни параметри:
SNumber - Номер на склад (ако е празен означава всички складове);
MNumA - списък(масив) от номера на артикули.
Резултат:
SNum - ID на склад;
SNumber - Номер на склад;
idMat - ID на артикул;
MNum - Номер на артикул;
ResNum - Резервация номер;
FromDate - От Дата;
ToDate - До Дата;
PNum - Клиент Номер (ако резервацията е за клиент);
OrderNum - Номер на клиентска поръчка (ако резервацията е от клиентска поръчка);
DocCode - Вид на документ за продажба/проформа (ако е свързана резервацията с такъв документ);
DocNum - Номер на документ за продажба/проформа;
UserFullName - Потребител създал резервацията;
QtyReservedSoft - Резервирано количество - обикновено;
QtyReservedHard - Резервиран количество - твърдо.
Връща списък с клиенти с номера между FromPNum и ToPNum. Ако се пропусне някой от параметъра се взима безкраен деапазон.
Пример 38. Описание на GetClients web service
Name: erpSOAPSell..GetClients Binding: erpserverBinding Endpoint: https://dev.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPSell..GetClients Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPSell..GetClientsRequest parts: FromPNum: xsd:string ToPNum: xsd:string Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPSell..GetClientsResponse parts: return: tns:partnerInfoArray Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation: Returns list of clients with numbers between FromPNum and ToPNum
Входни параметри:
FromPNum - От номер на клиент, тип: низ;
ToPNum - До номер на клиент, тип: низ.
Резултат - Връща списък с клиенти в посочения диапазон:
idPartner - уникален идентификатор за клиент, който не може да бъде променян; тип: реално число;
PNum - Номер на клиента, тип: низ;
PName - Име на клиента, тип: низ;
PAddr - Адрес на клиента, тип: низ;
PCity - Град, тип: низ;
PZip - Пощенски код, тип: низ;
PCPerson - Лице за контакти, тип: низ;
PDanN - Идентификационен номер по ЗДДС, тип: низ;
PDanR - Регистрация по ЗДДС, тип: низ;
PBulStat - Идентификационен номер, тип: низ;
idGeoRegion - Уникален идентификатор за регион на клиента, тип: реално число;
GeoAbbr - Регион абревиатура, тип: низ;
GeoName - Име на региона, тип низ;
BRANCHES - branchInfoArray - Списък с клоновете на клиента, тип масив:
- idBranch - Уникален идентификатор за клона, тип низ;
- BNum - Номер на клона, тип: низ;
- BName - Име на клона, тип: низ;
- BAddr - Адрес на клона, тип: низ;
- BCity - Град, тип: низ;
- BZip - Пощенски код, тип: низ;
- BCPerson - Лице за контакт, тип: низ;
- BDanN - Идентификационен номер по ЗДДС, тип: низ;
- BDanR - Регистрация по ЗДДС, тип: низ;
- BBulStat - Идентификационен номер, тип: низ;
- idGeoRegion - Уникален идентификатор за регион на клона, тип: низ;
- BGeoAbbr - Абревиатура на региона, тип: низ;
- BGeoName - Име на клона, тип: низ.
Връща списък с документи за продажба/доставка (Docs) за периода от FromD до ToD, или за от номер FromNum до ToNum, или за определен клиент/доставчик Pnum.
Пример 39. Описание на GetDocs web service
Name: erpSOAPSell..GetDocs Binding: erpserverBinding Endpoint: https://dev.edabg.com:443/erp/ws/wsbase.php SoapAction: urn:erpgate#erpSOAPSell..GetDocs Style: rpc Input: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPSell..GetDocsRequest parts: FromD: xsd:string ToD: xsd:string FromNum: xsd:string ToNum: xsd:string PNum: xsd:string Output: use: encoded namespace: urn:erpgate encodingStyle: http://schemas.xmlsoap.org/soap/encoding/ message: erpSOAPSell..GetDocsResponse parts: return: tns:DocInfoArray Namespace: urn:erpgate Transport: http://schemas.xmlsoap.org/soap/http Documentation: Returns list of Docs between (FromD and ToD) or (FromNum and ToNum), or for the specified PNum. The dates are in SQL format.
Входни параметри:
FromD - От дата на документ, тип: низ;
ToD - До дата на документ, тип: низ;
FromNum - От номер на документ, тип: низ;
ToNum - До номер на документ, тип: низ;
PNum - Номер на клиент, тип: низ.
Резултат: Връща списък с документи за продажба/доставка за посочените ограничения:
DocNum - Номер на документа, тип: низ;
AccDate - Дата на осчетоводяване на документа, тип: низ;
DocDate - Дата на документа, тип: низ;
DocCode - Вид на документа, тип: низ;
UserDeal - Сключил сделката, тип: низ;
curCode - Валута на документа, тип: низ;
dcmRate - Курс на валутата, тип: низ;
idPartner - Уникален идентификационен номер на клиента, тип: низ;
PNum - Номер на клиента, тип: низ;
PidBranch - Уникален идентификационен номер на клона на клиента, тип: низ;
BNum - Номер на клона на клиента, тип: низ;
idGeoRegion - Уникален идентификационен номер на региона на клиента, тип: низ;
ITEMS - DocItemArray - Списък от асортименти към документа за продажба/доставка:
- idMat - Уникален идентификационен номер на асортимент, тип: низ;
- MNum - Номер на асортимент, тип: низ;
- Quantity - Количество, тип: низ;
- Price - Единична цена без ДДС, тип: низ;
- PriceDDS - Единична цена с ДДС, тип: низ;
- Suma - Стойност без ДДС, тип: низ;
- SumaDDS - Стойност с ДДС, тип: низ.
Метод за получаване на глобално ценово ниво/корекция и ценови нива/корекция по групи асортименти.
Пример 40. Описание на getPriceLevels web service
erpSOAPPartner..getPriceLevels Description: Returns info about partner global price level and for product groups. Input: PNum type string Output: return type erpPartnerPriceLevel idPartner type integer PLNum type string PriceLevel type integer PriceLevelCor type double GROUPS type erpPartnerGPriceLevelArray - array of type erpPartnerGPriceLevel idGroup type integer GNum type string GPriceLevel type integer GPriceLevelCor type double Message type string
Входни параметри:
Заявката получава като входен параметър Номер на Партньора в Colibri® ERP - PNum.
Резултатът съдържа следните полета:
idPartner - Вътрешно ID на клиента;
PLNum - Номер на ценова лиска, ако ползва специфична;
PriceLevel - Номер на ценово ниво;
PriceLevelCor - Корекция в % от ценовото ниво;
GROUPS - Ценови нива/корекции по групи;
idGroup - Вътрешно ID на групата;
GNum - Номер на групата;
GPriceLevel - Ценово ниво за групата;
GPriceLevelCor - Корекция в % от ценовото ниво на групата.
Метод за получаване на ценово ниво/корекция или конкретна цена за асортименти.
Пример 41. Описание на getMatPrices web service
erpSOAPPartner..getMatPrices Description: Returns info about partner product prices valid from FromD date. Input: PNum type string FromD type date Output: return type erpPartnerMatPriceArray - array of type erpPartnerMatPrice idMat type integer MNum type string PRICES type erpPartnerMPriceArray - array of type erpPartnerMPrice DateStart type date MPriceLevel type integer MPriceLevelCor type double MPrice type double curCode type string Message type string
Входни параметри:
Заявката получава като входен параметър номер на Партньора в Colibri® ERP (PNum) и дата, от която да се вземат цените ($FromD).
Например при подаване на днешна дата в резултата ще се включат цените, актуални към днешна дата, както и такива, които влизат в сила след днешната дата.
Резултатът е масив със следната структура:
idMat - Вътрешно ID на артикула;
MNum - Номер на артикула;
PRICES - Списък от цени за артикула по дати;
DateStart - Начална дата на валидност на цената;
MPriceLevel - Ценово ниво;
MPriceLevelCor - Корекция в % от ценовото ниво;
MPrice - Конкретна цена. В случай, че MPriceLevel = 0;
curCode - Валута на цената MPrice.
Метод за получаване на каталог асортименти на партньора.
Пример 42. Описание на getMatCatalog web service
erpSOAPPartner..getMatCatalog Description: Returns info about partner product catalog. Input: PNum type string PType type string Output: return type erpPartnerMatCatalogArray - array of type erpPartnerMatCatalog idMat type integer MNum type string PMNum type string PMName type string PPrice type double PCurCode type string PBarcode type string Message type string
Входни параметри:
Заявката получава като входен параметър номер на Партньора в Colibri® ERP (PNum) и вида на партньора (pType). За клиент трябва да е 'C', за доставчик - 'D'.
Резултатът е масив със следната структура:
idMat - Вътрешно ID на артикула;
MNum - Номер на артикула;
PMNum - Номер на артикула за партньора;
PMName - Име на артикула за партньора;
PPrice - Каталожна цена;
PCurCode - Валута на цената;
PBarcode - Баркод на продукта за партньора.
Метод за обновяване/добавяне на цени.
Пример 43. Описание на erpSOAPStore..UpdateMatPrices
erpSOAPStore..UpdateMatPrices Source code Description: Update/insert mat prices Style: rpc Operation type: Request-response. The endpoint receives a message, and sends a correlated message. SOAP action: urn:erpgate#erpSOAPStore..UpdateMatPrices Input: erpSOAPStore..UpdateMatPricesRequest (soap:body, use = encoded)Source code MPSet type MatPriceListSet startDate type string curCode type string MPLIST type MatPriceSetInfoArray - array of type MatPriceSetInfo MNum type string Price0 type decimal Price1 type decimal Price2 type decimal Price3 type decimal Price4 type decimal Price5 type decimal Price6 type decimal Price7 type decimal Price8 type decimal Price9 type decimal SalePrice type decimal Output: erpSOAPStore..UpdateMatPricesResponse (soap:body, use = encoded)Source code return type integer
Задължително условие е потребителят (акаунта), с който работи Web Service, да има права за запис върху асортиментите и права за администриране на цени.
Параметър на метода е структура MPSet, със следните полета:
startDate - дата/час, от която влизат в сила цените във формат YYYY-mm-dd H:i:s;
curCode - код на валута. Например: BGN, EUR, USD ...;
MPLIST - списък от артикули с техните цени;
Price0..Price9 - цена за всяко от десетте възможни ценови нива, в зависимост от това с колко работи клиента. Цените трябва да намаляват с увеличаване на нивото т.е Price0>=Price1>=Price2 ...;
SalePrice - промоционална цена или цена на разпродажба (незадължително);
PCurCode - Валута на цената.
При успешно изпълнение метода връща броя на променените и добавени записи с цени.
Прилагаме Ви примерно извикване на метода:
След успешно преминал тест на вашата разработка с примерния web service или с наличните в момента и описани в Colibri® ERP WSDL файла, можете да преминете към разработка на необходимите ви web services.
Забележка | |
---|---|
Създаване на нови web services (неналични във Colibri® ERP WSDL файла) може да се извършва със съдействието на разработчиците на Colibri® ERP. |