API-ի միջոցով հնարավոր է ստանալ (POST) վաճառքերի վերլուծություն հաշվետվությունը։ Այն նախատեսված է կազմակերպության վաճառքները վերլուծելու համար։ Հաշվետվությունում երևում են վաճառքի ինքնարժեքները, վաճառքի գումարները և վաճառքից ստացված օգուտները/վնասները` գումարային և տոկոսային ներկայացմամբ։
URI |
https://api.armsoft.am/trade/v1/reports/salesanalysis |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Հարցման պարամետրեր (Request Body)
Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
startDate |
Date(YYYY-MM-DD) |
Ժամանակահատվածի սկզբի ամսաթիվ: |
|
endDate |
Date(YYYY-MM-DD) |
|
Ժամանակահատվածի վերջի ամսաթիվ: |
storages [0..n] |
Array |
Պահեստը, որտեղից կատարվել են վաճառքները: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն բոլոր պահեստներից վաճառքները։ Կարելի է նշել մեկ կամ մի քանի պահեստներ։ |
|
itemType |
Enum |
Ընդունում է հետևյալ արժեքները․ 1 - Ապրանք 2 - Ծառայություն Դաշտը դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն և' ապրանքները, և' ծառայությունները: |
|
itemsGroup |
String(5) |
Ապրանքի կամ ծառայության խմբի կոդ: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն բոլոր խմբերի ապրանքները և ծառայությունները: |
|
itemCode |
String(20) |
Ապրանքի կամ ծառայության կոդ: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն և՛ ապրանքները, և՛ ծառայությունները: |
|
partnersGroup |
String(5) |
Գործընկերոջ խմբի կոդ: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն գործընկերների բոլոր խմբերին կատարված վաճառքները: |
|
partnerCode |
String(20) |
Գործընկերոջ կոդ: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն բոլոր գործընկերներին կատարված վաճառքները: |
|
showQuantitiesWithAdditionalUnits |
Boolean |
Քանակները ցույց տալ լրացուցիչ չափման միավորով: |
|
showSumsWithoutVAT |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների ինքնարժեքները` ներկայացված դրամով և առանց ԱԱՀ-ի։ |
|
showSumsWithVAT |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների ինքնարժեքները` ներկայացված դրամով և ներառյալ ԱԱՀ-ն։ |
|
showCurrencySums |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների ինքնարժեքները` ներկայացված USD-ով և ներառյալ ԱԱՀ-ն։ |
|
showParties |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների խմբաքանակները բնորոշող սյուներ (Մուտքի ա/թ, Մատակարար, մուտքի փաստաթղթի N, Օգտ․ ժամկետ, Երկիր, Արտադրող և այլն)։ |
|
showCostAndSalePrices |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների ինքնարժեքներն ու վաճառքի գները: |
|
showDiscounts |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են վաճառքների ժամանակ կիրառված զեղչի գումարները և տոկոսները։ |
|
showBonusPoints |
Boolean |
True արժեքի դեպքում հաշվետվությունում երևում են բոնուսների կուտակումներն ու մարումները: |
|
showVATAmounts |
Boolean |
True արժեքի դեպքում կցուցադրվեն Վաճառքի գումարի ԱԱՀ և Ինքնարժեքի գումարի ԱԱՀ սյուներ: |
|
groupBy |
Enum |
Հաշվետվությունը կարելի է կանչել խմբավորված ըստ ապրանքների և ծառայությունների կամ ըստ գործընկերների։ Այդ դեպքում հաշվետվության մեջ միևնույն ապրանքների (գործընկերներին) վաճառքները երևում են մեկ տողով։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
documentNumber |
String |
Վաճառքի (վերադարձի) փաստաթղթի համար: |
date |
Date(YYYY-MM-DD) |
Վաճառքի (վերադարձի) փաստաթղթի ամսաթիվը: |
isn |
UUID |
Փաստաթղթի ներքին նույնացուցիչ (UUID): |
operationType |
String |
Գործողության տեսակի անվանում. Հաշիվ-ապրանքագիր, Վերադարձ գնորդից, Վաճառք (Կտրոն), Վաճառք (Մանրածախ): |
documentCurrency |
String |
Վաճառքի (վերադարձի) փաստաթղթի արժույթը: |
documentVATType |
String |
ԱԱՀ-ի հաշվարկի ձև: Ընդունում է հետևյալ արժեքները․ 1 - ԱԱՀ-ով, 2 - ԱԱՀ-ն այդ թվում, 3 - Առանց ԱԱՀ, 4 - Զրոյական ԱԱՀ, 5 - ԱԱՀ-ն այդ թվում 16.67 % |
documentVATTypeName |
String |
ԱԱՀ-ի հաշվարկի տեսակի անվանում: |
ecrCheckNumber |
String |
ՀԴՄ կտրոնի համար: |
itemType |
String |
Տեսակ: Ընդունում է հետևյալ արժեքները․ 1 - Ապրանք, 2 - Ծառայություն: |
itemTypeName |
String |
Տեսակի անվանում. Ապրանք, Ծառայություն: |
itemId |
Integer |
Ապրանքի (ծառայության) ներքին նույնացուցիչ: |
itemCode |
String |
Ապրանքի (ծառայության) կոդ: |
itemName |
String |
Ապրանքի (ծառայության) անվանում: |
unitMeasure |
String |
Չափման միավորի կոդը: |
unitMeasureAbbreviation |
String |
Չափման միավորի անվանում: |
storage |
String |
Պահեստի կոդ: |
storageName |
String |
Պահեստի անվանում: |
cashDesk |
String |
Դրամարկղի կոդ: |
cashDeskName |
String |
Դրամարկղի անվանում: |
customer |
String |
Գնորդի կոդ: |
customerName |
String |
Գնորդի անվանում: |
customerContractName |
String |
Գնորդի պայմանագրի անվանում |
quantity |
Decimal |
Վաճառքի (վերադարձի) քանակ: |
costAmountWithoutVAT |
Decimal |
Ինքնարժեքի գումար առանց ԱԱՀ: |
costPriceWithoutVAT |
Decimal |
Ինքնարժեքի գին առանց ԱԱՀ: |
salePriceWithoutVAT |
Decimal |
Վաճառքի գին առանց ԱԱՀ: |
saleAmountWithoutVAT |
Decimal |
Վաճառքի գումար առանց ԱԱՀ: |
profitWithoutVAT |
Decimal |
Շահույթ առանց ԱԱՀ: |
profitPercentBySaleWithoutVAT |
Decimal |
Վաճառքի շահութաբերություն առանց ԱԱՀ: |
profitPercentByCostWithoutVAT |
Decimal |
Վաճառքի արդյունավետություն առանց ԱԱՀ։ |
initialPriceWithoutVAT |
Decimal |
Սկզբնական գին առանց ԱԱՀ։ |
initialAmountWithoutVAT |
Decimal |
Սկզբնական գումար առանց ԱԱՀ։ |
discountPercentWithoutVAT |
Decimal |
Զեղչի % առանց ԱԱՀ։ |
discountAmountWithoutVAT |
Decimal |
Զեղչի գումար առանց ԱԱՀ։ |
costAmountWithVAT |
Decimal |
Ինքնարժեքի գումար ներառյալ ԱԱՀ։ |
costPricewithVAT |
Decimal |
Ինքնարժեքի գին ներառյալ ԱԱՀ։ |
salePriceWithVAT |
Decimal |
Վաճառքի գին ներառյալ ԱԱՀ։ |
saleAmountWithVAT |
Decimal |
Վաճառքի գումար ներառյալ ԱԱՀ։ |
profitWithVAT |
Decimal |
Շահույթ ներառյալ ԱԱՀ։ |
profitPercentBySaleWithVAT |
Decimal |
Վաճառքի շահութաբերություն ներառյալ ԱԱՀ։ |
profitPercentByCostWithVAT |
Decimal |
Վաճառքի արդյունավետություն ներառյալ ԱԱՀ։ |
initialPriceWithVAT |
Decimal |
Սկզբնական գին ներառյալ ԱԱՀ։ |
initialAmountWithVAT |
Decimal |
Սկզբնական գումար ներառյալ ԱԱՀ։ |
discountPercentWithVAT |
Decimal |
Զեղչի % ներառյալ ԱԱՀ։ |
discountAmountWithVAT |
Decimal |
Զեղչի գումար ներառյալ ԱԱՀ։ |
costVATAmount |
Decimal |
Ինքնարժեքի գումարի ԱԱՀ։ |
costVATPrice |
Decimal |
Ինքնարժեքի ԱԱՀ։ |
saleVATAmount |
Decimal |
Վաճառքի գումարի ԱԱՀ։ |
discountVATAmount |
Decimal |
Զեղչի գումարի ԱԱՀ։ |
costAmountCurrency |
Decimal |
Ինքնարժեքի գումար արտարժույթով։ |
costPriceCurrency |
Decimal |
Ինքնարժեքի գին արտարժույթով։ |
salePriceCurrency |
Decimal |
Վաճառքի գին արտարժույթով։ |
saleAmountCurrency |
Decimal |
Վաճառքի գումար արտարժույթով։ |
profitCurrency |
Decimal |
Շահույթ արտարժույթով։ |
profitPercentBySaleCurrency |
Decimal |
Վաճառքի շահութաբերություն արտարժույթով։ |
profitPercentByCostCurrency |
Decimal |
Վաճառքի արդյունավետություն արտարժույթով։ |
initialPriceCurrency |
Decimal |
Սկզբնական գին արտարժույթով։ |
initialAmountCurrency |
Decimal |
Սկզբնական գումար արտարժույթով։ |
discountPercentCurrency |
Decimal |
Զեղչի % արտարժույթով։ |
discountAmountCurrency |
Decimal |
Զեղչի գումար արտարժույթով։ |
usedBonus |
Decimal |
Օգտագործված բոնուսային միավորներ։ |
accumulatedBonus |
Decimal |
Հաշվարկված բոնուսային միավորներ։ |
description |
String |
Նկարագրություն։ |
seller |
String |
Վաճառողի կոդ։ |
sellerName |
String |
Վաճառողի անվանում։ |
comment |
String |
Վաճառքի (վերադարձի) փաստաթղթի մեկնաբանություն: |
itemGroup |
String |
Ապրանքների խումբ։ |
itemSpecification |
String |
Ապրանքի բնութագիր։ |
businessAddress |
String |
Գործունեության հասցե։ |
incomeDate |
Date(YYYY-MM-DD) |
Ապրանքի խմբաքանակի. մուտքագրման ամսաթիվ: |
partySupplierId |
Integer |
Ապրանքի խմբաքանակի մատակարարի ներքին նույնացուցիչ։ |
partySupplierName |
String |
Ապրանքի խմբաքանակ. մատակարարի անվանում: |
partySupplierTaxCode |
String |
Ապրանքի խմբաքանակի մատակարարի ՀՎՀՀ: |
partyContractName |
String |
Ապրանքի խմբաքանակի մատակարարման պայմանագիր: |
partyDocumentTypeName |
String |
Ապրանքի խմբաքանակի մատակարարման փաստաթղթի տեսակ: |
partyDocumentNumber |
String |
Ապրանքի խմբաքանակի մատակարարման փաստաթղթի համար: |
partyCountryName |
String |
Ապրանքի խմբաքանակը արտադրող երկիր: |
partyProducerName |
String |
Ապրանքի խմբաքանակի արտադրողը: |
partyBase |
UUID |
Ապրանքի խմբաքանակի փաստաթղթի ներքին նույնացուցիչը։ |
partyRow |
Integer |
Ապրանքի խմբաքանակի փաստաթղթի տողի համար։ |
|
POST |
|