API-ի միջոցով հնարավոր է ստանալ (POST) Նյութական արժեքների ցուցակը։
URI |
https://api.armsoft.am/accountant/v1/directories/materials/list |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Materials/post_v1_directories_materials_list |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
codes |
Array |
Optional Reference type |
Նյութական արժեքների կոդերը։ |
lastModifiedDate |
Enum |
Optional |
Վերջին խմբագրման ամսաթիվը։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Նյութական արժեքի ներքին նույնացուցիչ։ |
code |
String |
Նյութական արժեքի կոդ։ |
name |
String |
Նյութական արժեքի անվանում։ |
fullName |
String |
Նյութական արժեքի լրիվ անվանում։ |
unitMeasure |
String |
Նյութական արժեքի չափման միավորի կոդ։ |
unitMeasureAbbreviation |
String |
Նյութական արժեքի չափման միավորի հապավում: |
group |
String |
Նյութական արժեքի խմբի կոդ: |
cpaClassifier |
String |
Նյութական արժեքի ԱՏԳԱԱ դասակարգիչ: |
account |
String |
Նյութական արժեքի հաշվառման հաշիվ։ |
wholePrice |
Decimal |
Նյութական արժեքի մեծածախ վաճառքի գին։ |
retailPrice |
Decimal |
Նյութական արժեքի մանրածախ վաճառքի գին։ |
specification |
String |
Նյութական արժեքի բնութագիր։ |
barcode |
String |
Նյութական արժեքի գծիկավոր կոդ։ |
externalCode |
String |
Նյութական արժեքի արտաքին կոդ։ |
costingMethod |
Enum |
Նյութական արժեքի հաշվառման մեթոդի կոդ։ Ընդունում է հետևյալ արժեքները․ 1 - ՖԻՖՈ (առաջինը մուտք՝ առաջինը ելք), 2 - ԼԻՖՈ (վերջինը մուտք՝ առաջինը ելք), 3 - Միջին կշռված գնով։ |
aoeCoefficient |
String |
Հավելյալ ծախսերի բաշխման գործակից։ |
discountPercent |
Decimal |
Նյութական արժեքի զեղչի տոկոս։ |
environmentalFeePercent |
Decimal |
Նյութական արժեքի բնապահպանական հարկի %։ |
minimumQuantity |
Decimal |
Նյութական արժեքի մնացորդի նվազագույն քանակային մեծություն։ |
maximumQuantity |
Decimal |
Նյութական արժեքի մնացորդի առավելագույն քանակային մեծություն։ |
vat |
Boolean |
ԱԱՀ-ով հաշվառվող համարվելու հայտանիշ։ |
revenueAccount |
String |
Նյութական արժեքի մեծածախ վաճառքից հասույթի հաշիվ։ |
retailRevenueAccount |
String |
Նյութական արժեքի մանրածախ վաճառքից հասույթի հաշիվ։ |
expenseAccount |
String |
Նյութական արժեքի վաճառքից ծախսի հաշիվ։ |
revenueAdjustmentAccount |
String |
Նյութական արժեքի վաճառքից վերադարձի հասույթի ճշգրտման հաշիվ։ |
lastModifierName |
String |
Վերջին խմբագրողի անվանում։ |
Օրինակ 1. Նյութական արժեքների ցուցակի ստացում
|