API-ի միջոցով հնարավոր է ստանալ (POST) համակարգում գրանցված բոլոր տեսակի փաստաթղթերի ցանկը:
URI |
https://api.armsoft.am/trade/v1/journals/alldocuments |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Նշում։ Եթե հարցումը իրականացնող օգտագործողը Ադմինիստրատորի իրավասություն չունի և նրա համար սահմանափակված է աշխատանքը այլ օգտագործողներին պատկանող փաստաթղթերի հետ, ապա հարցման դեպքում կվերադարձվի միայն տվյալ օգտագործողի կողմից ստեղծված փաստաթղթերի ցանկը:
Հարցման պարամետրեր (Request Body)
Մատյանի ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
{ "startDate": "2026-01-01", "endDate": "2026-02-28", "documentTypes": [ "01", "02" ], "currency": "AMD", "partnerCode": "1001", "documentState": "0" } |
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
startDate |
Date(YYYY-MM-DD) |
*Required |
Ժամանակահատվածի սկզբի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
endDate |
Date(YYYY-MM-DD) |
*Required |
Ժամանակահատվածի վերջի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
documentTypes [0..n] |
Array |
Optional Reference type |
Փաստաթղթերի տեսակների ցանկ։ Աղյուսակում նշված են բոլոր տեսակի փաստաթղթերի կոդերը։ |
currency |
String(3) |
Optional Reference type |
Արժույթ, ըստ որի կառուցվում է մատյանը: |
partnerCode |
String(20) |
Optional Reference type |
Գործընկերոջ կոդ: Մատյանում կընդգրկվեն միայն նշված գործընկերոջ հետ կապված փաստաթղթերը: |
itemCode |
String(20) |
Optional Reference type |
Ապրանքի (ծառայության) կոդ։ Մատյանում կընդգրկվեն միայն նշված ապրանքի հետ կապված փաստաթղթերը: |
employeeCode |
String(12) |
Optional Reference type |
Աշխատակցի կոդ։ Մատյանում կընդգրկվեն միայն նշված աշխատակցի հետ կապված փաստաթղթերը: |
documentState |
Enum |
Optional |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները. 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 3 - Հեռացված: Արժեք չտալու դեպքում համակարգը կվերադարձնի բոլոր փաստաթղթերը անկախ վիճակից։ |
owner |
String(50) |
Optional Reference type |
Մատյանում կընդգրկվեն միայն նշված Հեղինակի փաստաթղթերը: Դաշտը դատարկ լինելու դեպքում կընդգրկվեն բոլոր հեղինակների փաստաթղթերը: |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
isn |
UUID |
Փաստաթղթի ներքին նույնացուցիչ։ |
date |
Date(YYYY-MM-DD) |
Փաստաթղթի ստեղծման ամսաթիվ: |
dayOrderNumber |
Integer |
Փաստաթղթի օրվա հերթական համար։ |
documentNumber |
String |
Փաստաթղթի համար: |
type |
Enum |
Փաստաթղթի տեսակի կոդ։ Աղյուսակում նշված են բոլոր տեսակի փաստաթղթերի կոդերը։ |
typeName |
String |
Փաստաթղթի տեսակի անվանում։ |
currency |
String |
Փաստաթղթի արժույթ։ |
amount |
Decimal |
Փաստաթղթի գումար: |
state |
Integer |
Փաստաթղթի վիճակի կոդ: |
stateName |
String |
Փաստաթղթի վիճակի անվանում։ |
storageCode |
String |
Պահեստի կոդ։ |
storageName |
String |
Պահեստի անվանում։ |
information |
String |
Այս դաշտում լրացվում է տվյալ փաստաթղթի հետ կապված առավել կարևոր տեղեկություն։ Աղյուսակում նշված է, թե յուրաքանչյուր փաստաթղթի համար ինչ տեղեկություն է լրացվում այս սյունում։ |
comment |
String |
Մեկնաբանություն փաստաթղթի վերաբերյալ: |
partnerId |
Integer |
Գործընկերոջ ներքին նույնացուցիչ։ |
partnerCode |
String |
Գործընկերոջ կոդ: |
partnerName |
String |
Գործընկերոջ անվանում: |
partnerTaxCode |
String |
Գործընկերոջ ՀՎՀՀ: |
employeeCode |
String |
Աշխատակցի կոդ։ |
employeeName |
String |
Աշխատակցի անվանում։ |
userName |
String |
Օգտագործողի անունը: Նշվում է այն օգտագործողի անունը, ով վերջինն է աշխատել (գրանցել կամ խմբագրել) տվյալ փաստաթղթի հետ: |
lastChange |
Date(YYYY-MM-DDTHH:mm:ss) |
Փաստաթղթի վերջին խմբագրման ամսաթիվը և ժամը: |
owner |
String |
Փաստաթղթի հեղինակը։ |
Կոդ |
Փաստաթուղթ |
01 |
Վճարման հանձնարարագիր |
02 |
Դրամարկղի մուտքի օրդեր |
03 |
Դրամարկղի ելքի օրդեր |
04 |
Բանկի մուտք |
05 |
Բանկի ելք |
06 |
Գործընկերոջ պարտքի վերանայում |
07 |
Պահեստի մուտքի օրդեր |
08 |
Վաճառք (Հաշիվ-Ապրանքագիր) |
09 |
Պահեստի ելքի օրդեր |
10 |
Ապրանքների տեղաշարժ |
11 |
Կոմպլեկտավորում |
12 |
Ապակոմպլեկտավորում |
13 |
Հավելյալ ծախսերի բաշխում |
14 |
Վերադարձ մատակարարին |
15 |
Վերադարձ գնորդից |
16 |
Ապրանքների գույքագրում |
17 |
Վերագնահատում |
18 |
Վաճառք (Կտրոն) |
19 |
Պահեստի մուտքի օրդեր (Ներմուծում) |
20 |
Պահեստի մուտքի օրդեր (Մանրածախ) |
21 |
Վաճառք (Մանրածախ) |
22 |
Ապրանքների գույքագրում (Մանրածախ) |
23 |
Ապրանքների վերագնահատում (Մանրածախ) |
24 |
Ապրանքների մնացորդների մուտք |
25 |
Գործընկերների խմբային վերագնահատում |
26 |
Ստացված հաշիվ |
27 |
Գործընկերոջ պարտքի տեղափոխում |
28 |
Գործընկերոջ պարտքի վերանայում (Խմբային) |
29 |
Ստացված ծառայություններ |
30 |
Բոնուսների խմբային վերանայում |
32 |
Պատվեր մատակարարին |
33 |
Փոխանցման հաշիվ |
34 |
Փոխադարձ հաշվարկների ստուգման ակտ |
35 |
Ապրանքի ինքնարժեքի վերագնահատում |
36 |
Ապրանքների տեղաշարժի պատվեր |
38 |
Վերադարձ (Կտրոն) |
information դաշտում վերադարձվող տեղեկության նկարագրությունը
Փաստաթուղթ |
Տեղեկություն |
Պահեստի մուտքի օրդեր |
Մատակարարի անվանումը։ |
Պահեստի մուտքի օրդեր (ներմուծում) |
Մատակարարի անվանումը։ |
Պահեստի մուտքի օրդեր (Մանրածախ) |
Մատակարարի անվանումը։ |
Հավելյալ ծախսերի բաշխում |
Մատակարարի անվանումը։ |
Վերադարձ մատակարարին |
Մատակարարի անվանումը։ |
Վաճառք (Հաշիվ-Ապրանքագիր) |
Գնորդի անվանումը։ |
Վաճառք (Մանրածախ) |
Գնորդի անվանումը։ |
Վաճառք (Կտրոն) |
Դրամարկղի անվանումը։ |
Վերադարձ գնորդից |
Գնորդի անվանումը։ |
Դրամարկղի մուտքի օրդեր |
Վճարող դաշտում լրացված տեքստը։ |
Դրամարկղի ելքի օրդեր |
Տրամադրել դաշտում լրացված տեքստը։ |
Վճարման հանձնարարագիր |
Ստացող դաշտում լրացված տեքստը։ |
Բանկի մուտք |
Գործընկերոջ անվանումը։ |
Բանկի ելք |
Գործընկերոջ անվանումը։ |
Ապրանքների տեղաշարժ |
Մուտքի պահեստի անվանումը։ |
Կոմպլեկտավորում |
Կոմպլեկտի անվանումը։ |
Ապակոմպլեկտավորում |
Կոմպլեկտի անվանումը։ |
Գործընկերոջ պարտքի վերանայում |
Գործընկերոջ անվանումը։ |
Ապրանքների մնացորդների մուտք |
Մատակարարի անվանումը: |
Օրինակ 1. 2026թ. հունվար ամսվա բոլոր փաստաթղթերի ստացում
|
Օրինակ 2. 2026թ. հունվար ամսվա նշված գործընկերոջ դրամային (AMD) 01 և 02 տեսակի գրանցված և սևագիր փաստաթղթերի ստացում
POST |
|