API

Balance Exchange Service Description

 

 

Using Web-services

 

With Balance Exchange services it is possible to exchange the following documents: master data, documents and typical operations.

Web-Services can be used with the formats

<ServerIPaddress>/Balance_Exchange/hs/Exchange/<URLtemplate>

The name of the published base must be: Balance_Exchange

<ServerIPaddress> - Server address, where Balance database is published.

<URLtemplate> - Means the object of exchange.

 

In order to use the function of Balance exchange with web-services, it is necessary to make exchange usage available:

 

  •        Tab “administration”
  •        Data synchronization settings
  •        Check “WS exchange search settings

 

 

 

Clients

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Clients

  •        Create – POST method.
  •        Update/Create - PUT method.
  •        Modify – PATCH method.
  •        Read- GET method.

The description of the services is generated from the program.

 

 

Sales> Customers > The description of the services;

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Group ჯგუფი Catalog Customer    
FullName სრული დასახელება String (150)   Depends on Name  
ID ს/ნ String (50)     YES
LegalForm სამართლებრივი ფორმა List Legal forms “Limited Liability Company”  
           
Currency ვალუტა Catalog Currency Accounting Currency  
VATType დღგ-ით დაბეგვრა List VAT Taxable “VAT Payer”  
ByAgreements ანგარიშსწორება ხელშეკრულებების მიხედვით Boolean   FALSE  
MainAgreement ძირითადი ხელშეკრულება Catalog Customer Contract “Default Contract”  
ReceivablesAccount ანგარიშსწორების აღრიცხვის ანგარიში Account   Default Accounts  
AdvancesAccount ავანსების აღრიცხვის ანგარიში Account   Default Accounts  
VATArticle დღგ-ის მუხლი Catalog VAT Aritcle VATType by meaning  
LegalAddress იურიდიული მისამართი String (150)      
PhysicalAddress ფაქტიური მისამართი String (150)      
Phone ტელეფონი String (150)      
Fax ფაქსი String (150)      
Email ელექტრონული ფოსტა String (255)      
PostAddress საფოსტო მისამართი String (Indefinite)      
AdditionalInformation დამატებითი ინფორმაცია String (Indefinite)      
Country ქვეყანა Catalog Countries „საქართველო“  
BankAccount საბანკო ანგარიში String (50) Bank Account Number    

 

 

 

Clients agreements

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/ClientsAgreements

 

 

The description of the services is generated from the program.

Sales> Customers > The description of the services;

Master Data - Customer Agreements

 

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Owner მფლობელი Catalog Customer   YES
Currency ვალუტა Catalog Currency Depends on Owner  
Number ნომერი String (30)      
Date თარიღი Date   Current Date  
Comments კომენტარები String (Indefinite)      
StartDate მოქმედების დაწყების თარიღი Date      
EndDate მოქმედების დასრულების თარიღი Date      
VATType დღგ-ით დაბეგვრა List VAT taxable types Depends on Owner  
ReceivablesAccount ანგარიშსწორების აღრიცხვის ანგარიში Account   Depends on Owner  
AdvancesAccount ავანსების აღრიცხვის ანგარიში Account   Depends on Owner  
VATArticle დღგ-ის მუხლი Catalog VAT Aritcle VATType by the meaning   
If VATType is not transmissioned. Owner by the meaning

 

 

Vendors

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Vendors

The description of the services is generated from the program.

Purchase > Suppliers> The description of the services;

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Group ჯგუფი Catalog Supplier    
FullName სრული დასახელება String (150)   Depends on Name  
ID ს/ნ String (50)     YES
LegalForm სამართლებრივი ფორმა List Legal forms “Limited Liability Company”  
           
Currency ვალუტა Catalog Currency Accounting Currency  
VATType დღგ-ით დაბეგვრა List VAT Taxable “VAT Payer”  
ByAgreements ანგარიშსწორება ხელშეკრულებების მიხედვით Boolean   FALSE  
MainAgreement ძირითადი ხელშეკრულება Catalog Supplier Contract “Default contrcat”  
PayablesAccount ანგარიშსწორების აღრიცხვის ანგარიში Account   Default Accounts  
AdvancesAccount ავანსების აღრიცხვის ანგარიში Account   Default Accounts  
ReverseChargeVATAccount უკუდაბეგვრის დღგ-ის ანგარიში Account   Default Accounts  
PersonalIncomeTax საშ. გად.-ის გათვალისწინება Boolean   FALSE  
PersonalIncomeTaxRate საშ. გად.-ის განაკვეთი Catalog Withholding Tax Rate    
ItemComplianceType ნომენკლატურების შესაბამისობა List Item correspondence “According to the names”  
LegalAddress იურიდიული მისამართი String (150)      
PhysicalAddress ფაქტიური მისამართი String (150)      
Phone ტელეფონი String (150)      
Fax ფაქსი String (150)      
Email ელექტრონული ფოსტა String (255)      
PostAddress საფოსტო მისამართი String (Indefinite)      
AdditionalInformation დამატებითი ინფორმაცია String (Indefinite)      
RecoverableVATAccount ჩასათვლელი დღგ-ს ანგარიში Account   Default Accounts  
Country ქვეყანა Catalog Countries “საქართველო”  
WaybillComplianceType სზ შესაბამისობის კონტროლის ტიპი List Waybill correspondence control „Auto“  
BankAccount საბანკო ანგარიში String (50) Bank account number    

 

 

Vendors agreements

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/VendorsAgreements

 

The description of the services is generated from the program.

Purchase > Suppliers> The description of the services;

Master data – Vendor Contracts

 

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Owner მფლობელი Catalog Supplier   YES
Currency ვალუტა Catalog Currency Depends on owner  
Number ნომერი String (30)      
Date თარიღი Date   Current date  
Comments კომენტარები String (Indefinite)      
PersonalIncomeTax საშ. გად.-ის გათვალისწინება Boolean   Owner by the meaning (if is not transmissioned PersonalIncomeTaxRate)  
PersonalIncomeTaxRate საშ. გად.-ის განაკვეთი Catalog Withholding Tax Rate Depends on owner  
StartDate მოქმედების დაწყების თარიღი Date      
EndDate მოქმედების დასრულების თარიღი Date      
VATType დღგ-ით დაბეგვრა List VAT taxable types Depends on owner  
PayablesAccount ანგარიშსწორების აღრიცხვის ანგარიში Account   Depends on owner  
AdvancesAccount ავანსების აღრიცხვის ანგარიში Account   Depends on owner  
ReverseChargeVATAccount უკუდაბეგვრის დღგ-ის ანგარიში Account   Depends on owner  
RecoverableVATAccount ჩასათვლელი დღგ-ს ანგარიში Account   Depends on owner  
IncomeTaxObject მოგების გადასახადით დაბეგვრის ობიექტი Catalog Profit tax taxable objects    
IndicateIncomeTaxObject მიეთითოს დაბეგვრის ობიექტი მოგების გადასახადის მიხედვით Boolean   FALSE  

 

 

Employees

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Employees

The description of the services is generated from the program.

 

Salary> Staff> The description of the services;

 

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Group ჯგუფი Catalog Staff    
ID პირადი ნომერი String (12)     YES
LegalAddress იურიდიული მისამართი String (150)      
PhysicalAddress ფაქტიური მისამართი String (150)      
PhoneNumber ტელეფონი String (150)      
Fax ფაქსი String (150)      
Email ელექტრონული ფოსტა String (255)      
PostAddress საფოსტო მისამართი String (Indefinite)      
Other სხვა String (Indefinite)      
Sex სქესი List Individual gender    
BirthDate დაბადების თარიღი Date      
HireDate მიღების თარიღი Date     YES
DismissalDate გათავისუფლების თარიღი Date      
Condition მდგომარეობა List Employee status “Received on work”  
Country რეზიდენტობის ქვეყანა Catalog Countries „საქართველო“  
BankAccount საბანკო ანგარიში String (50) Bank account number    
Department დეპარტამენტი Catalog Department   YES
Position თანამდებობა Catalog Position    
AccrualType დარიცხვა Catalog Accruals and deductions Default Accrual Type  
AccrualGrossAmount თანხა გროსი Number (13/2)      
DeductionType დაკავება Catalog Accruals and deductions    
DeductionGrossAmount თანხა გროსი Number (13/2)      
TaxPreference გამოქვითვა გამოიყენება Date      
PreferenceRate გამოქვითვის პროცენტი Number (3/0)      
PreferenceAmount გამოქვითვის თანხა Number (13/2)      
PreviousIncome შემოსავალი წინა სამუშაო ადგილიდან Number (13/2)      

 

 

 

Fixed assets

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/FixedAssets

The description of the services is generated from the program.

Fixed Assets> Fixed Assets > The description of the services;

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Group ჯგუფი Catalog Fixed assets    
Description აღწერა String (150)      
AssetNumber საინვენტარო ნომერი String (25)      
Insured დაზღვეულია Boolean   FALSE  
WarrantyReceived მიღებულია გარანტია Boolean   FALSE  
Category კატეგორია Catalog Categories of fixed assets    
Lease ლიზინგი List Leasing status    
LeaseDate ლიზინგის თარიღი Date      
AssetAccount აღრიცხვის ანგარიში Account   Depends on Category YES
DepreciationAccount ამორტიზაციის ანგარიში Account   Depends on Category  
ExpensesAccount ხარჯების ანგარიში Account   Depends on Category  
State სტატუსი List Fixed assets status “Active”  
ServiceStartDate ექსპლუატაციაში შესვლის თარიღი Date      
TaxGroup საგადასახადო ჯგუფი Catalog Tax groups of fixed assets Depends on Category YES
OwnershipType საკუთრების ფორმა List Fixed assets possession form    
Model მოდელი String (100)      
ReleaseDate გამოშვების (აშენების) თარიღი Date      
PurchaseDate შესყიდვის თარიღი Date   Current date  
PurchasePrice შესყიდვის ღირებულება Number (13/2)      
WriteOffDate ჩამოწერის თარიღი Date      
Department დეპარტამენტი Catalog Department    
Warehouse ადგილმდებარეობა (საწყობი) Catalog Warehouse    
ResponsiblePerson პასუხისმგებელი პირი Catalog Staff    
DepreciationStartDate ამორტიზაციის დაწყების თარიღი Date      
DepreciationMethod ამორტიზაციის დარიცხვის მეთოდი List Depreciation parameters    
ResidualValue სალიკვიდაციო ღირებულება Number (13/2)      
UsefulLife გამოყენების ვადა (თვე) Number (4/0)      
Analytics1 ანალიტიკა 1 Analytics ExpensesAccountAnalytics    
Analytics2 ანალიტიკა 2 Analytics ExpensesAccountAnalytics    
Analytics3 ანალიტიკა 3 Analytics ExpensesAccountAnalytics    
Analytics4 ანალიტიკა 4 Analytics ExpensesAccountAnalytics    

 

Items

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Items

 

 

The description of the services is generated from the program.

Warehouse > Item > The description of the services;

 

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator With PATCH method
Name დასახელება String (150)     YES
Group ჯგუფი Catalog Item    
InternalArticle არტიკული String (12)      
Unit ზომ. ერთეული Catalog Classification of units of measurement „ცალი“  
ItemType ნომენკლატურის ტიპი List Item types „Goods”  
Weight წონა Number (12/3)      
VATRate დღგ-ის განაკვეთი Catalog VAT rate „ჩვეულებრივი“  
InventoriesAccount მარაგების აღრიცხვის ანგარიში Account   Default Accounts  
ExpensesAccount ხარჯების აღრიცხვის ანგარიში (მომსახურების) Account   Default Accounts  
RevenuesAccount შემოსავლების აღრიცხვის ანგარიში Account   Default Accounts  
CostsAccount ხარჯების აღრიცხვის ანგარიში (საქონლის) Account   Default Accounts  
VATPayableAccount დარიცხული დღგ-ის ანგარიში Account   Default Accounts  
ImportTaxRate იმპორტის განაკვეთი Catalog Import rate    
Barcode შტრიხკოდი String (200)      
FullName სრული დასახელება String (150)   Depends on Name  
VATArticle დღგ-ის მუხლი Catalog VAT article 1. „Sale by compensation”  
2. If the articale does not match to VATRate, by the meaning of VATRate.
OwnProduction საკუთარი წარმოების პროდუქტი Boolean   FALSE  
ProductionAccount წარმოების Account      
UnitCost ტარიფი Number (13/2)      
LoadingPerVehicle ტევადობა ერთ ტრანსპორტზე Number (13/2)      
Price ფასი Number (11/4) Not negative    

 

 

ცხრილი: Packages

 

 

Name Description Exchange type Type Default value Required
Package დასახელება String (150)      
Coefficient კოეფიციენტი Number (7/3)      

 

 

 

Typical operations

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/TypicalOperations/{TemplateCode}

The parameterTemplateCodeis template’s code.

 

 

Types, defaultfillings and necessaryfields depend on the template.

The description of the services is generated from the program:

 

Operations > Typical operations > description of web services;

 

After choosing the template, server address and description will be generated

 

 

Purchase

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Purchase

 

The description of the services is generated from the program.

 

Purchases > purchase > The description of the services;

 

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator  
Date თარიღი Date     YES
OperationType ოპერაციის ტიპი List Purchase operation types “Purchase from the supplier”  
Branch ფილიალი Catalog Branch Default Branch YES
Warehouse საწყობი Catalog Warehouse Default Warehouse If Item type is Good
Vendor მომწოდებელი Catalog Supplier   YES
Agreement ხელშეკრულება Catalog Supplier contract Depends on Vendor  
AmountIncludesVAT თანხა შეიცავს დღგ-ის Boolean   TRUE  
PriceType ფასის ტიპი Catalog Price type Default Price Type  
Currency ვალუტა Catalog Currency 1. Depends on Vendor/Agreement  
2. Accounting Currency
CurrencyRate კურსი Number (2/13)   Current Currency Rate  
VendorAccount მომწოდებლის ანგარიში Account   Depends on Vendor/Agreement YES
AdvancesAccount ავანსის ანგარიში Account   Depends on Vendor/Agreement If table: AdvancesPaid is filled
ReverseChargeVATAccount უკუდაბეგვრის დღგ-ის ანგარიში Account   Depends on Vendor/Agreement VATType = “Reverse charge VAT”
IncludeWithholdingTax საშ. გად.-ის გათვალისწინება Boolean   FALSE  
If OperationType = „Purchase by import” , always false
Comments კომენტარები String (Indefinite)      
AdvanceHolder ანგარიშვალდებული პირი Catalog Staff    
AdvanceHolderAccount ანგარიშვალდებულის ანგარიში Account   Default Accounts OperationType =
“Purchase by advance holder”
VATType დღგ-ით დაბეგვრა List VAT taxable types 1. Depends on Vendor/Agreement;  
2. If OperationType = „Purchase by import”, „Import“
ReceivableVATAccount დღგ-ის ანგარიში Account   Depends on Vendor/Agreement VATType = „VAT Payer“ or “Reverse charge VAT”
WithholdingTaxExpenseAccount საშემოსავლოს ხარჯის ანგარიში Account   Default Accounts IncludeWithholdingTax = true and WithholdingTaxAccount filled
WithholdingTaxAccount გადასახდელი საშემოსავლო გადასახადის ანგარიში Account   Default Accounts IncludeWithholdingTax = true and OperationType = “Purchase by advance holder”
PrimaryDocument პირველადი დოკუმენტი String (50)      
RevenuesAndExpensesAnalytics შემოსავალ-ხარჯების ანალიტიკა Catalog Revenue-Expenses analytics    
Department დეპარტამენტი Catalog Department Default Department  

 

 

ცხრილი: AdvancesPaid

 

 

Name Description Exchange type Default value Required
AdvanceDate ავანსის თარიღი Date    
AmountInCurrency ვალ. თანხა Number (13/2) Depends on Amount Amount = 0
Amount თანხა Number (13/2) Depends on AmountInCurrency AmountInCurrency = 0
CurrencyRate  კურსი  Number (6/4) 1. Depends on AmountInCurrency and Amount when both are filled.  
2. Current Currency Rate

 

 

ცხრილი: Others

 

 

Name Description Exchange type Type Default value Required
Description შინაარსი String (1024)     YES
Amount თანხა Number (13/2)     YES
VATRate დღგ-ის განაკვეთი Catalog VAT rate 1. If VATType = „No VAT tax payer”, - “Without VAT“  
2. „ჩვეულებრივი“
WithholdingTaxRate საშ. გად.-ის განაკვეთი Catalog Witholding Tax rate If IncludeWithholdingTax = true, Depends on Vendor/Agreement  
AccountNumber აღრიცხვის ანგარიში Account     YES
Analytics1 ანალიტიკა 1 Analytics AccountNumberAnalytics    
Analytics2 ანალიტიკა 2 Analytics AccountNumberAnalytics    
Analytics3 ანალიტიკა 3 Analytics AccountNumberAnalytics    
Analytics4 ანალიტიკა 4 Analytics AccountNumberAnalytics    

 

 

ცხრილი: Items

 

 

Name Description Exchange type Type Default value Required
Item ნომენკლატურა Catalog Item   YES
Unit ერთ. Catalog Unites of measurement, Item by the meaning  
Classification of units of measurement.
Quantity რაოდენობა Number (12/3)   1  
Price ფასი Number (11/4)   1. Depends on Item If Price is not set and
2. Depends on Amount Amount=0
Amount თანხა Number (13/2)   Price, WithholdingTaxRate, VATRate  by the meaning Price = 0
WithholdingTaxRate საშ. გად.-ის განაკვეთი Catalog Witholding Tax rate If IncludeWithholdingTax = true, Depends on Vendor/Agreement  
VATRate დღგ-ის განაკვეთი Catalog VAT rate 1. If VATType = „No VAT tax payer”, - “Without VAT“  
2. Depends on Item
3. „ჩვეულებრივი“
AccountNumber აღრიცხვის ანგარიში Account   Depends on Item YES
Analytics1 ანალიტიკა 1 Analytics AccountNumberAnalytics    
Analytics2 ანალიტიკა 2 Analytics AccountNumberAnalytics    
Analytics3 ანალიტიკა 3 Analytics AccountNumberAnalytics    
Analytics4 ანალიტიკა 4 Analytics AccountNumberAnalytics    

 

 

Sales

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Sale

 

 

The description of the services is generated from the program.

 

Sales > Sale > The description of the services;

 

 

Name Description Exchange type Type Default value Required
uid უნიკალური იდენტიფიკატორი Guid   New unique identificator  
Date თარიღი Date     YES
Branch ფილიალი Catalog Branch Default Branch YES
Department დეპარტამენტი Catalog Department Default Department  
Warehouse საწყობი Catalog Warehouse Default Warehouse YES
Client მყიდველი Catalog Customer   YES
Agreement ხელშეკრულება Catalog Customer contract Depends on Client  
AmountIncludesVAT თანხა შეიცავს დღგ-ის Boolean   TRUE  
PriceType ფასის ტიპი Catalog Price types 1. Depends on Client  
2. Default Price Type
Currency ვალუტა Catalog Currency 1. Depends on Client/Agreement  
2. Accounting Currency
CurrencyRate კურსი Number (2/13)   Current Currency Rate  
ReceivablesAccount მყიდველის ანგარიში Account   Depends on Client/Agreement YES
AdvancesAccount ავანსის ანგარიში Account   Depends on Client/Agreement If table: AdvancesPaid is filled
Comments კომენტარები String (Indefinite)      
VATExpenseAccount დღგ - ფინანსური ხარჯის ანგარიში Account   Default Accounts DoesNotAffectReceivables = true, or
VATArticle = „Sales without compensation” and profit tax payble object is „Difference between Gross income and deducitions”
DifferenceAccount სხვაობის ანგარიში Account   Default Accounts DoesNotAffectReceivables = true and profit tax payble object is „Difference between Gross income and deducitions”
ReceivablesWriteoffAccount დავალიანების გადაფარვის ანგარიში     Default Accounts VATArticle = „Sale without compensation” and DoesNotAffectReceivables = false
VATArticle დღგ-ის მუხლი Catalog VAT article 1. Depends on Client/Agreement  
2. “Sale by compensation”
DoesNotAffectReceivables არ აისახება ანგარიშსწორების ანგარიშზე Boolean   FALSE  
PrimaryDocument პირველადი დოკუმენტი String (50)      
RevenuesAndExpensesAnalytics შემოსავალ-ხარჯების ანალიტიკა Catalog Revenue-Expenses analytics.    
SubjetToIncomeTax იბეგრება მოგების გადასახადით Boolean   If VATArticle = „Sale without compensation” and profit tax payble object is „Distributed profit”,- True  
IncomeTaxType მოგების გადასახადით დაბეგვრის ობიექტი Catalog Profit Tax payble “Free delivery of goods service” SubjetToIncomeTax = true
CapitalAccount კაპიტალის ანგარიში Account   Default Accounts SubjetToIncomeTax = true
IncomeTaxAccount მოგების გადასახადის ანგარიში Account   Default Accounts SubjetToIncomeTax = true

 

 

 

ცხრილი: AdvancesPaid

 

 

Name Description Exchange type Default value Required
AdvanceDate ავანსის თარიღი Date    
AmountInCurrency ვალ. თანხა Number (13/2) Depends on Amount Amount = 0
Amount თანხა Number (13/2) Depends on AmountInCurrency AmountInCurrency = 0
CurrencyRate  კურსი  Number (6/4) 1. Depends on AmountInCurrency and Amount by the meaning, if both are filled.  
2. Current Currency Rate

 

 

 

ცხრილი: Others

 

 

Name Description Exchange type Type Default value Required
Description შინაარსი String (1024)     YES
Amount თანხა Number (13/2)     YES
VATArticle დღგ-ის მუხლი Catalog VAT article Document’s VATArticle  
VATRate დღგ-ის განაკვეთი Catalog VAT rate VATArticle by the meaning  
VATPayableAccount დღგ-ის ანგარიში Account     VAT > 0
RevenueAccount შემოსავლების ანგარიში Account     YES
Waybill ს/ზ Boolean   FALSE  
RevenuesAndExpensesAnalytics შემოსავალ-ხარჯების ანალიტიკა Catalog Revenue-Expenses analytics    

 

 

 

ცხრილი: Items

 

 

 

Name Description Exchange type Type Default value Required
Item ნომენკლატურა Catalog Item   YES
Unit ერთ. Catalog Unit of measurement Depends on Item  
Quantity რაოდენობა Number (12/3)   1  
Price ფასი Number (11/4)   1. Depends on Item Price is not set and fields calculated = 0
2. Depends on Amount
Discount ფასდაკლება Number (13/2)   Depends on Price, Amount, DiscountedPrice if  * always 0 Fields calculated = 0
DiscountedPrice ფასი ფასდაკლებით Number (11/4)   Depends on Price, Amount, Discount if  * always Price Fields calculated = 0
Amount თანხა Number (13/2)   Depends on Price, Discount, DiscountedPrice, VATRate Fields calculated = 0
AccountNumber აღრიცხვის ანგარიში Account   Depends on Item If Item type is Good
VATPayableAccount დღგ-ის ანგარიში Account   Depends on Item VAT > 0
IncomeAccount შემოსავლების ანგარიში Account   Depends on Item YES
ExpensesAccount ხარჯების ანგარიში Account   Depends on Item If Item type is Good
RevenuesAndExpensesAnalytics შემოსავალ-ხარჯების ანალიტიკა Catalog Revenue-Expenses Analytics    

 

 

Sale order

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/SalesOrders

 

 

The description of the services is generated from the program.

 

Salees > Sales orders > The description of the services;

 

 

 

ცხრილი: Inventory

 

 

Name Description Exchange type Type Default value Required
Production პროდუქცია Catalog Item    
Item ნომენკლატურა Catalog Item    
Quantity რაოდენობა Number (12/3)   1  
Unit ერთ. Catalog Unit of measurment Depends on Item  
Reserve რეზერვი Number (12/3)   0  

 

 

ცხრილი: Items

 

 

Name

Description

Exchange type

Type

Default value

Required

Item

ნომენკლატურა

Catalog

Item

 

YES

Unit

ერთ.

Catalog

Unit of measurment

Depends on Item

 

Quantity

რაოდენობა

Number (12/3)

 

1

Price

ფასი

Number (11/4)

 

  1. Depends on Item

2. Depends on Amount

If Price is not set and calculated fields = 0

Discount

ფასდაკლება

Number (13/2)

 

Depends on Price, Amount, DiscountedPrice if  * always 0

Calculated fields  = 0

DiscountedPrice

ფასი ფასდაკლებით

Number (11/4)

 

Depends on Price, Amount, Discount if  * always Price

Calculated fields  = 0

Amount

თანხა

Number (13/2)

 

Depends on Price, Discount, DiscountedPrice, VATRate

Calculated fields  = 0

VATRate

დღგ-ისგანაკვეთი

Catalog

VAT rate

1. თუ VATType = „No VAT tax payer” – “Without VAT”

2. Depends on Item

3. „ჩვეულებრივი“

 

Reserve

რეზერვი

Number (12/3)

 

0

 

Specification

სპეციფიკაცია

Catalog

 

Specification

 

 

 

Prices

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Prices

 

  •        Read–With GET method.

 

Optional parameters: Date, PriceType, Item.

 

Service returns all item prices for given date (Date).

 

Service will return item prices for current date if parameters ar not given.

 

If parameters ar given, returned information can be filtered by given one price type (PriceType) and by given one item (Item). Objects will be identified based on search types, indicated in settings. Search types can be found in Settings.

 

Simultaniosly it is possible to use one or several filters.

 

For example, for current date all item prices can be returned with:

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Prices

For given date, given price type and given item, prices can be returned with:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Prices?Date=""&PriceType=""&Item=""

Items will not be returned if no set price was found for given parameters.

 

Restrictions:

 

As a default service have access to all prices for any price type.

It is possible to grant access to prices for one given price type in the program.

To view or edit list of permitted price types, go to:

Administration > Data synchronization settings > All price types are allowed

 

 

 

After entering the price types in the list, service will only have access to item prices for entered price types.

 

Responses:

 

400 Invalid date format

404 Price type / Item not found

200 OK

 

 

Stocks

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Stocks

 

  •        Read–With GET method.

 

Optional parameters: Date, Item, Warehouse, Branch.

Service returns all item stocks for given date (Date).

Service will return item stocks for current date if parameters ar not given.

 

If parameters ar given, returned information can be filtered by given one item (Item), by given one warehouse (Warehouse) and by given one branch (Branch). Objects will be identified based on search types, indicated in settings. Search types can be found in Settings.

 

Simultaniosly it is possible to use one or several filters.

 

For example, for current date all item stocks can be returned with:

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Stocks

For given date, given item, given warehouse and given branch, stocks can be returned with:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Stocks?Date=""&Item=""&Warehouse=""&Branch=""

Items will not be returned if no free stock was found for given parameters.

 

Restrictions:

 

As a default service have access to all item stocks for any warehouse.

It is possible to grant access to item stocks for one given warehouse in the program.

To view or edit list of permitted warehouses, go to:

 

Administration > Data synchronization settings > All warehouses are allowed

 

 

 

After entering the warehouses in the list, service will only have access to item stocks for entered warehouses.

 

Responses:

 

400 Invalid date format

404 Item / Warehouse / Branch not found

200 OK

 

 

 

Vendor Balances

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/VendorsBalances

 

  •        Read – With GET method.

 

Optional parameters: Date, Vendor, VendorAgreement, Branch.

Service returns all vendors balances for given date (Date).

Service will return vendors balances for current date if parameters ar not given.

 

If parameters ar given, returned information can be filtered by given one vendor (Vendor), by given vendor agreement (VendorAgreement) and by given one branch (Branch). Objects will be identified based on search types, indicated in settings. Search types can be found in Settings.

 

Simultaniosly it is possible to use one or several filters.

 

For example, for current date all vendors balances can be returned with:

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/VendorsBalances

For given date, given vendor, given vendor agreement and given branch, balances can be returned with:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/VendorsBalances?Date=""&Vendor=""&VendorAgreement=""&Branch=""

Vendors will not be returned if no debt balance was found for given parameters.

 

Responses:

 

400 Invalid date format

404Vendor / VendorAgreement / Branch not found

200 OK

 

 

 

Client Balances

 

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/ClientsBalances

 

  •        Read – With GET method.

 

Optional parameters: Date, Client, ClientAgreement, Branch.

Service returns all clients balances for given date (Date).

Service will return clients balances for current date if parameters ar not given.

 

If parameters ar given, returned information can be filtered by given one client (Client), by given client agreement (ClientAgreement) and by given one branch (Branch). Objects will be identified based on search types, indicated in settings. Search types can be found in Settings.

 

Simultaniosly it is possible to use one or several filters.

 

For example, for current date all clients balances can be returned with:

 

<ServerIPaddress>/Balance_Exchange/hs/Exchange/ClientsBalances

For given date, given client, given client agreement and given branch, balances can be returned with:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/ClientsBalances?Date=""&Client=""&ClientAgreement=""&Branch=""

Clients will not be returned if no debt balance was found for given parameters.

 

Responses:

 

400 Invalid date format

404Client / ClientAgreement / Branch not found

200 OK

 

 

Description of Web-Services

 

Catalogs

Web-service description is generated from the program for any Catalog object.

For example, for clients:

 

  •        Select “Sales” tab
  •        Select Clients from Master data

 

Select “Description of Web Services” on list of clients 

 

 

 

 

List of clients:

 

 

 

Parameters description table and JSON code is generated:

 

 

 

  Agreements

 

Open description for client or vendor agreements and select desired agreement:

 

 

 

Methods

 

Create – With POST method.

 

Only used for new objects.

It is necessary to give all parameters. (Parameters that will not be given, will be filled with default values or will remain empty).

Objects are identified according to settings. If object already exists in the database response will be an error.

New object will get new unique identifier or given uid.

* Used for only one object. Incase of posting catalogue, only the first object will be created.

 

Responses:

 

400 Bad Request (JSON cannot be read. E.g. Syntax error.)

400 Invalid uid (Invalid uid was given.)

400 Not saved (Object cannot be saved. Detailed information in the text.)

409 Already exists (Object already exists.)

201 Created (Object was created successfully)

Location: Link of created object. Returns it’s data incase of GET method.

 

Update/Create – With PUT method.

 

Existing objects can be updated or created new ones.

It is necessary to give all parameters. (Parameters that will not be given, will be filled with default values or will be cleared/will remain empty).

Objects are identified according to settings. If object cannot be found in database, it will be created. (New object will get new unique identifier or given uid.)

If object has tabular parts, only the necessary table data should be given. If empty parameters will be given, an empty line will be added.

* Used for only one object. Incase of putting catalogue, only the first object will be created / updated.

* Use POST method for creating new objects.

 

Responses:

 

400 Bad Request (JSON cannot be read. E.g. Syntax error.)

400 Invalid uid (Invalid uid was given.)

400 Not saved (Object cannot be saved. Detailed information in the text.)

400 Not posted. Required fields are empty

400 Not posted (document cannot be posted. Detailed information in the text.)

404 Template not found

200 OK (Catalog/document updated/posted successfully.)

201 Created (Catalog/document created/posted successfully.)

Location: Link of created object. Returns it’s data using GET method.

 

 

Modify – With PATCH method.

 

Used only for existing objects.

 

Only those parameters can be given, that need to be updated (Not given parameters won’t be modified).

Objects are identified according to settings. If object cannot be found in database, response will be error.

* Used for only one object. Incase of patching catalogue, only the first object will be modified.

 

Responses:

 

400 Bad Request (JSON cannot be read. E.g. Syntax error.)

400 Invalid uid (Invalid uid was given.)

400 Not saved (Object cannot be saved. Detailed information in the text.)

404 Unknown parameter

404 Not Found (Object not found.)

200 OK (Object was modified successfully.)

 

 

Read– With GET method.

 

Used for reading existing objects.

Can read one or more object, or even the whole catalogue.

Method returns JSON code or consequent response.

To read whole catalogue, use same format.

For example, for clients address will be:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Clients

To read pack of the catalogue, pack number and pack size should be given as a parameter.

For example, to read the third pack of a twenty items, address will be:

ServerIPaddress>/Balance_Exchange/hs/Exchange/Items?Pack=3&PackSize=20

If PackSize is not given as a parameter, default packsize will be 1000

To read one object, use search type and value as a parameter.

For given object, any search type can be used.

For example, to read client, with ID – “01234567890”, address will be:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/Clients?ID=01234567890

Search types can be found insettings.

 

! Important

 

* To read client/vendor agreements, additionally can be searched by Owner. With folowing address:

<ServerIPaddress>/Balance_Exchange/hs/Exchange/ClientsAgreements?Owner=01234567890

Owner will be idetified, by search type indicated to client/vendor settings.

 

Responses:

 

404 Unknown parameter

400 Invalid uid

404 Not Found (Object not found.)

200 OK (Object was successfully read.)

 

 

 

 

Search settings

 

To view or edit search settings, go to;

Administration > Data synchronization settings > WS exchange search settings

 

 

 

 

Search type can only be selected for listed objects.

 

Selected search type will be used for identify objects while creating, updating and reading. (Other objects will be identifed with Guid).

 

E.g. clients van be identified by one of these listed types:

 

 

 

To use desired search type to identify object, select it in the list and press “Save”. After this, you should use this parameter when you want to transfer Client data with web services. This parameter will be used to search objects while updating it or choosing it in the document.

 

 

Guid – Generate unique identifier

 

Guid can be generated for any object, that exists in the database. It can be geneated from list form of desired object (Catalog element/document).

For example, to fill currency with EUR for clients, we should generate Guid of EUR:

  •        Select “Sales” tab
  •        Select Clients from Master data
  •        Select “Description of Web Services” on list of clients
  •        Select “Guid Generator”
  •        Select Add > Tip > Currency > EUR
  •        Unique identifier will generate in Guid column

 

 

 

\

 

Default fillings

 

Default Accounts

Accounts, that are filled in default accounts on quick menu tab.

 

Accounting Currency

Currency indicated in “Accounting currency” on Admnistration tab > Accounting settings > Financial accounting

 

Default Accrual Type

Value of same constant name. (Is filled with “ხელფასი“ (Salary), by default if it exists in the database.)

 

Default Price Type

Price type indicated in user settings.

 

Default Department

Department indicated in user settings.

 

Default Branch

Branch indicated in user settings.

 

Default Warehouse

Warehouse indicated in user settings.

 

Current Currency Rate

Exchange rate of currency indicated in the object for object date.

 

Description of types

Number – Maximum length with format (Int / Fraction). For rational numbers, maximum length of parameter will be sum of length of integer and fraction part of the number (Int + Fraction).

 

String -  Maximum length is indicated.

Boolean – Standard JSON format: 'true' / 'false', 1 / 0.

Date – Standard JSON format. E.g: 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'

Catalog – Master data

 

Is identifed by Guid identifier or it depends on search settings.

Document

Is identifed by Guid identifier

 

Account

Is identified by account code. (String type.)

 

List

Is identified by string values from the list.

 

Analytics

Depends on an account, of which analytics you are filling. (indicated in Type.) Values can be given by it’s own analytics rule.

 

Guid – Unique Identifier

Format: xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx

 

 

 

List

Legal forms

 

Individual Entity
Limited Liability Company
Individual
Joint liability community
Joint stock company
Limited Partnership
Cooperative
Nonprofit legal entity
Branch of foreign enterprise
Foreign enterprise
Legal entity of public law
State authority
Non-resident natural person
Partnership
Branch of a foreign non-commercial legal entity
Budgetary Organization

 

 

VAT taxable types

 

 

VAT Payer
No VAT tax payer
Import
Reverse charge VAT
Export
Diplomat

 

 

Item correspondence

 

 

According to article
According to the names

 

 

Waybill correspondence control

 

 

Do not control
According to the positions
According to the total amount
Auto

 

 

Individual gender

 

 

Female
Male

 

 

Employee status

 

 

Received on work
Dismissed

 

 

Leasing status

 

 

Issued
Accepted
Absent

 

 

Fixed assets status

 

 

Not active
Active
Written off

 

 

Fixed assets possession form

 

 

own
Rent
Leasing
Other

 

 

Depreciation parameters

 

 

Linear
Tax
Is not accrued
Linear (by days)

 

 

Item types

 

 

Goods
Service
Job

 

 

Purchase operation types

 

Purchase from the supplier
Purchase by import
Purchase by advance holder