Շրջանառություն |
  
|
Շրջանառություն |
|
API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող Շրջանառություն հաշվետվությունը:
URI |
https://api.armsoft.am/accountant/v1/reports/accountsturnover |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_accountsturnover |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: @SKq7*ERI]ZIgXvpkWhV' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Հարցման պարամետրեր (Request Body)
Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
startDate |
Date(YYYY-MM-DD) |
*Required |
Ժամանակահատվածի սկզբի ամսաթիվ: |
endDate |
Date(YYYY-MM-DD) |
*Required |
Ժամանակահատվածի վերջի ամսաթիվ: |
account |
String(12) |
Optional Reference type |
Հաշիվ։ Հաշվետվության մեջ կընդգրկվեն նշված հաշվի և նրա ենթահաշիվների շրջանառությունը: Չլրացնելու դեպքում կընդգրկվեն բոլոր հաշիվների շրջանառությունները: |
currency |
String(3) |
Optional Reference type |
Արժույթը, ըստ որի կառուցվում է հաշվետվությունը: |
reportCurrency |
Enum |
*Required |
Նշվում է հաշվետվության արժույթը․ 1 - ԱԴՄ-ով, 2 - Արտարժույթով, 3 - ԱԴՄ-ով և արտարժույթով միաժամանակ: Արժեք չտալու դեպքում վերադարձվում են ԱԴՄ-ով տվյալները։ |
accountsSection |
Enum |
*Required |
Նշվում է հաշվի պատկանելիության բաժինը․ 1 - Հաշվեկշռային, 2 - Արտահաշվեկշռային 3 - Բոլորը: Արժեք չտալու դեպքում վերադարձվում են հաշվեկշռային հաշիվների շրջանառությունները։ |
showOnlyLastLevels |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն միայն վերջին մակարդակի հաշիվները: |
showPartners |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև գործընկերների շրջանառությունները: |
showAnalytics1 |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև անալիտիկ խմբերի շրջանառությունները: |
showAnalytics2 |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև անալիտիկ խմբերի շրջանառությունները: |
showZeroRows |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև զրոյական մնացորդ ունեցող հաշիվները: |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
account |
String |
Հաշիվ։ |
name |
String |
Հաշվի անվանում։ |
nameRU |
String |
Հաշվի ռուսերեն անվանում։ |
partnerId |
Integer |
Գործընկերոջ ներքին նույնացուցիչ։ |
partnerCode |
String |
Գործընկերոջ կոդ։ |
partnerName |
String |
Գործընկերոջ անվանում։ |
startDebitCurrencyAmount |
Decimal |
Սկզբնական դեբետային մնացորդ արժույթով։ |
startCreditCurrencyAmount |
Decimal |
Սկզբնական կրեդիտային մնացորդ արժույթով։ |
startDebitAmount |
Decimal |
Սկզբնական դեբետային մնացորդ դրամով։ |
startCreditAmount |
Decimal |
Սկզբնական կրեդիտային մնացորդ դրամով։ |
turnoverDebitCurrencyAmount |
Decimal |
Դեբետային շրջանառություն արժույթով։ |
turnoverCreditCurrencyAmount |
Decimal |
Կրեդիտային շրջանառություն արժույթով։ |
turnoverDebitAmount |
Decimal |
Դեբետային շրջանառություն դրամով։ |
turnoverCreditAmount |
Decimal |
Կրեդիտային շրջանառություն դրամով։ |
endDebitCurrencyAmount |
Decimal |
Վերջնական դեբետային մնացորդ արժույթով։ |
endCreditCurrencyAmount |
Decimal |
Վերջնական կրեդիտային մնացորդ արժույթով։ |
endDebitAmount |
Decimal |
Վերջնական դեբետային մնացորդ դրամով։ |
endCreditAmount |
Decimal |
Վերջնական կրեդիտային մնացորդ դրամով։ |
outOfBalance |
Boolean |
Արտահաշվեկշռային հաշիվ հանդիսանալու հայտանիշ։ |
accountType |
Enum |
Հաշվի տեսակը՝ 1 - Ակտիվային, 2 - Պասիվային, 3 - Ակտիվային կամ Պասիվային։ |
leaf |
Boolean |
Վերջին մակարդակի հաշիվ հանդիսանալու հայտանիշ։ |
isPartnerAccount |
Boolean |
Գործընկերով հաշվառվող հաշիվ հանդիսանալու հայտանիշ։ |
isAnalytic1 |
Boolean |
Անալիտիկ խումբ 1-ով հաշվառվող հաշիվ հանդիսանալու հայտանիշ։ |
isAnalytic2 |
Boolean |
Անալիտիկ խումբ 2-ով հաշվառվող հաշիվ հանդիսանալու հայտանիշ։ |
path |
String |
Հաշիվները, որոնց մեջ մտնում է տվյալ ենթահաշիվը։ |
parent |
String |
Կուտակիչ հաշիվ։ |
Օրինակ 1. 2026 թ.-ի վերջին մակարդակի հաշվեկշռային հաշիվների շրջանառության ստացում
|
