API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող ապրանքների մնացորդներ հաշվետվությունը ընդլայնված դաշտերով։
URI |
https://api.armsoft.am/trade/v1/reports/productsbalances |
URL Swagger |
https://api.armsoft.am/trade/swagger/index.html#/Reports/post_v1_reports_productsbalances |
GitHub |
https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/reports/productsbalances.md |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Հարցման պարամետրեր (Request Body)
Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վեչադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
date |
Date(YYYY-MM-DD) |
*Required |
Մնացորդների ձևավորման ամսաթիվ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
storages [0..n] |
Array |
Optional Reference type |
Պահեստի կոդ: Դատարկ թողնելու դեպքում կընդգրկվեն բոլոր պահեստների մնացորդները։ |
group |
String(5) |
Optional Reference type |
Ապրանքի խմբի կոդը: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն բոլոր խմբերի ապրանքները։ |
codes [0..n] |
Array |
Optional Reference type |
Ապրանքի կոդը: |
showQuantitiesWithAdditionalUnits |
Boolean |
Optional |
True արժեքի դեպքում քանակները ցուցադրվում են լրացուցիչ չափման միավորով: |
showSumsWithoutVAT |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների մեկ միավորի միջինացված ինքնարժեքները և ընդհանուր գումարները` ներկայացված դրամով և առանց ԱԱՀ-ի։ |
showSumsWithVAT |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների մեկ միավորի միջինացված ինքնարժեքները և ընդհանուր գումարները` ներկայացված դրամով և ներառյալ ԱԱՀ-ն։ |
showCurrencySums |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների ինքնարժեքները` ներկայացված USD-ով և ներառյալ ԱԱՀ-ն։ |
showByDifferentParties |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում երևում են ապրանքների խմբաքանակները բնորոշող սյուներ (մուտքի ամսաթիվ, մատակարար, օգտագործման ժամկետ, երկիր, արտադրող և այլն)։ |
openedByStorages |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում տարբեր պահեստներում գտնվող միևնույն ապրանքը երևում է առանձին տողերով։ |
minimumQuantities |
Enum |
Optional |
Ընդունում է հետևյալ արժեքները․ 1 - Ցույց տալ նվազագույնից փոքր քանակները, 2 - Ցույց տալ բոլորը: Ցույց տալ նվազագույնից փոքր քանակները ընտրելու դեպքում հաշվետվությունում երևում են այն ապրանքները, որոնց համար լրացված է Նվազագույն քանակ դաշտը և տվյալ պահին այդ ապրանքի առկայությունը նշված նվազագույն քանակից քիչ է։ Ցույց տալ բոլորը ընտրելու դեպքում հաշվետվությունում ընդգրկվում են բոլոր ապրանքները։ |
subtotalType |
Enum |
Optional |
Նշված լինելու դեպքում հաշվետվությունը խմբավորվում է ըստ ենթագումարների: Կարող է ընդունել հետևյալ արժեքները. 1 - Պահեստ, 2 - Խումբ, 3 - Ապրանք: |
priceListTypes [0..n] |
Array |
Optional Reference type |
Կարելի է լրացնել կազմակերպությունում գործող որևէ գնի տեսակ, և եթե տվյալ ապրանքն ունի սահմանված այդ տեսակի գին, ապա այն կերևա հաշվետվության մեջ։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
storage |
String |
Պահեստի կոդ: |
storageName |
String |
Պահեստի անվանում: |
group |
String |
Ապրանքի խմբի կոդ: |
groupName |
String |
Ապրանքի խմբի անվանում: |
costPriceWithoutVAT |
Decimal |
Ինքնարժեք (առանց ԱԱՀ): |
costPriceWithVAT |
Decimal |
Ինքնարժեք (ներառյալ ԱԱՀ): |
costPriceCurrency |
Decimal |
Ինքնարժեք արտարժույթով: |
minimumQuantity |
Decimal |
Նվազագույն քանակ։ |
variance |
Decimal |
Շեղում(%)։ |
maximumQuantity |
Decimal |
Առավելագույն քանակ։ |
orderQuantity |
Decimal |
Պատվերի քանակ։ |
orderComment |
Decimal |
Պատվերի մեկնաբանություն։ |
incomeDate |
Date(YYYY-MM-DD) |
Ապրանքի խմբաքանակ. մուտքագրման ամսաթիվ: |
partySupplierId |
Integer |
Ապրանքի խմբաքանակի մատակարարի ներքին նույնացուցիչ։ |
partySupplierName |
String |
Ապրանքի խմբաքանակի մատակարարի անվանում։ |
partySupplierTaxCode |
String |
Ապրանքի խմբաքանակի մատակարարի ՀՎՀՀ։ |
partyContractCode |
String |
Ապրանքի խմբաքանակի պայմանագրի կոդ։ |
partyContractName |
String |
Ապրանքի խմբաքանակի պայմանագրի անվանում։ |
partyDocumentNumber |
String |
Ապրանքի խմբաքանակի փաստաթղթի համար։ |
partyDocumentType |
String |
Ապրանքի խմբաքանակի փաստաթղթի տեսակ։ |
partyCountryCode |
String |
Ապրանքի խմբաքանակի երկրի կոդ։ |
partyCountryName |
String |
Ապրանքի խմբաքանակի երկրի անվանում։ |
partyProducerCode |
String |
Ապրանքի խմբաքանակի արտադրողի կոդ։ |
partyProducerName |
String |
Ապրանքի խմբաքանակի արտադրողի անվանում։ |
partyPropertyType1Code |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության տեսակ 1-ի կոդ: |
partyPropertyType1Name |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության տեսակ 1-ի անվանում: |
partyPropertyValue1Code |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության արժեք 1-ի կոդ: |
partyPropertyValue1Name |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության արժեք 1-ի անվանում: |
partyPropertyType2Code |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության տեսակ 2-ի կոդ: |
partyPropertyType2Name |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության տեսակ 2-ի անվանում: |
partyPropertyValue2Code |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության արժեք 2-ի կոդ: |
partyPropertyValue2Name |
String |
Ապրանքի խմբաքանակի ապրանքի հատկության արժեք 2-ի անվանում: |
partyBase |
UUID |
Ապրանքի մուտքի խմբաքանակի փաստաթղթի ներքին նույնացուցիչ։ |
partyRow |
Integer |
Ապրանքի մուտքի խմբաքանակի փաստաթղթի տողի համար։ |
prices |
Decimal |
Ապրանքի մուտքի խմբաքանակի փաստաթղթի տողի համար։ |
id |
Integer |
Ապրանքի գինը ըստ դիալոգ պատուհանում նշված գնի տեսակի։ |
code |
String |
Ապրանքի կոդը։ |
name |
String |
Ապրանքի անվանումը։ |
fullName |
String |
Ապրանքի լրիվ անվանումը։ |
specification |
String |
Ապրանքի բնութագիրը։ |
unitMeasure |
String |
Ապրանքի չափման միավորի կոդը։ |
unitMeasureAbbreviation |
String |
Ապրանքի չափման միավորի հապավումը։ |
quantity |
Decimal |
Ապրանքի քանակը։ |
costAmountWithoutVAT |
Decimal |
Ապրանքի ինքնարժեքի գումարը առանց ԱԱՀ։ |
costAmountWithVAT |
Decimal |
Ապրանքի ինքնարժեքի գումարը ԱԱՀ-ով։ |
costAmountCurrency |
Decimal |
Ապրանքի ինքնարժեքի գումարը արտարժույթով։ |
Օրինակ 1. 31.01.2026թ.-ի դրությամբ բոլոր ապրանքների մնացորդների ստացում (ընդլայնված տվյալներով)
|
Օրինակ 2. 31.01.2026թ.-ի դրությամբ 00 և 03 պահեստներում առկա նշված կոդերով ապրանքների մնացորդների և 01 ու 02 գնի տեսակով գների ցանկի ստացում (ընդլայնված տվյալներով)
POST |
|