API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող Մնացորդներ հաշվետվությունը:
URI |
https://api.armsoft.am/accountant/v1/reports/accountsbalances |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_accountsbalances |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: @SKq7*ERI]ZIgXvpkWhV' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Հարցման պարամետրեր (Request Body)
Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
accountSection |
Enum |
*Required |
Հաշվի պատկանելիության բաժին։ Ընդունում է հետևյալ արժեքները․ 1 - Հաշվեկշռային, 2 - Արտահաշվեկշռային, 3 - Բոլորը։ Եթե արժեք չի փոխանցվում, ապա օգտագործվում է 1 - Հաշվեկշռային արժեքը։ |
date |
Date(YYYY-MM-DD) |
*Required |
Մնացորդների ձևավորման ամսաթիվ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
reportCurrency |
Enum |
*Required |
Պարտադիր լրացվող դաշտ է: Եթե դաշտում լրացված է 1 - Ցույց տալ գումարները դրամով արժեքը, ապա հաշվետվությունում բոլոր գումարները երևում են ներկայացված դրամային համարժեքով։ 2 - Ցույց տալ գումարները արժույթով արժեքի դեպքում գումարները երևում են այն արժույթով, որով կատարվել են գործողությունները։ 3 - Ցույց տալ գումարները և դրամով և արժույթով արժեքի դեպքում հաշվետվությունում արտացոլվում են և’ արժույթով գումարները, և’ նրանց դրամային համարժեքները: Եթե արժեք չի փոխանցվում, ապա օգտագործվում է 1- Ցույց տալ գումարները դրամով արժեքը: |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
account |
String(12) |
Optional Reference type |
Հաշիվ: Հաշվետվության մեջ կընդգրկվեն նշված հաշվի և նրա ենթահաշիվների մնացորդները: Չլրացնելու դեպքում կընդգրկվեն բոլոր հաշիվների մնացորդները: |
currency |
String(3) |
Optional Reference type |
Արժույթ, ըստ որի կառուցվում է հաշվետվությունը։ |
showOnlyLastLevels |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն միայն վերջին մակարդակի հաշիվները։ |
showPartners |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև գործընկերների մնացորդները։ |
showAnalytics1 |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև անալիտիկ խմբերի մնացորդները։ |
showAnalytics2 |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև անալիտիկ խմբերի մնացորդները։ |
showZeroRows |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում կընդգրկվեն նաև 0-ական մնացորդ ունեցող հաշիվները։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
account |
String(12) |
Հաշիվ։ |
name |
String(255) |
Հաշվի անվանում։ |
nameRU |
String(255) |
Հաշվի ռուսերեն անվանում։ |
debitAmount |
Decimal |
Դեբետային մնացորդ դրամով։ |
creditAmount |
Decimal |
Կրեդիտային մնացորդ դրամով |
outOfBalance |
Boolean |
Արտահաշվեկշռային հաշիվ հանդիսանալու նշիչ։ |
accountType |
Enum |
Հաշվի տեսակ։ Ընդունում է հետևյալ արժեքները․ 1 - Ակտիվային, 2 - Պասիվային, 3 - Ակտիվային կամ Պասիվային։ |
leaf |
Boolean |
Վերջին մակարդակի հաշիվ հանդիսանալու հայտանիշ։ |
isPartnerAccount |
Boolean |
Գործընկերային հաշիվ հանդիսանալու հայտանիշ։ |
isAnalytic1 |
Boolean |
Անալիտիկ խումբ 1-ով հաշվառվող հանդիսանալու հայտանիշ։ |
isAnalytic2 |
Boolean |
Անալիտիկ խումբ 2-ով հաշվառվող հանդիսանալու հայտանիշ։ |
path |
String |
Հաշիվը, որի մեջ մտնում է տվյալ ենթահաշիվը։ |
parent |
String(12) |
Կուտակիչ հաշիվ։ |
partnerId |
Integer |
Գործընկերոջ ներքին նույնացուցիչ։ |
Օրինակ 1. 31.03.2026թ.-ի դրությամբ հաշվեկշռային հաշիվների մնացորդների ստացում
|