API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող Գործընկերների մնացորդներ հաշվետվությունը:
URI |
https://api.armsoft.am/accountant/v1/reports/partnersbalances |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_partnersbalances |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
date |
Date(YYYY-MM-DD) |
*Required |
Մնացորդների ձևավորման ամսաթիվը: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
partnerGroup |
String(5) |
Optional Reference type |
Գործընկերների խումբ: |
partner |
String(20) |
Optional Reference type |
Գործընկեր։ |
account |
String(12) |
Optional Reference type |
Հաշիվ: |
currency |
String(3) |
*Conditional required Reference type |
Փաստաթղթի արժույթի կոդ: Եթե արժեք չենք տալիս, ավտոմատ լրացվում է ծրագրի դրույթներում նշված արժեքը։ |
reportCurrency |
Enum |
*Required Reference type |
Պարտադիր լրացվող դաշտ է: Եթե դաշտում լրացված է 1 - Ցույց տալ գումարները դրամով արժեքը, ապա հաշվետվությունում բոլոր գումարները երևում են ներկայացված դրամային համարժեքով։ 2 - Ցույց տալ գումարները արժույթով արժեքի դեպքում գումարները երևում են այն արժույթով, որով կատարվել են գործողությունները։ 3 - Ցույց տալ գումարները և դրամով և արժույթով արժեքի դեպքում հաշվետվությունում արտացոլվում են և’ արժույթով գումարները, և’ նրանց դրամային համարժեքները: Եթե արժեք չի փոխանցվում, ապա օգտագործվում է 1- Ցույց տալ գումարները դրամով արժեքը: |
accountsSection |
Enum |
Optional |
Հաշվի պատկանելիության բաժին՝ 1․Հաշվեկշռային, 2․Արտհաշվեկշռային, 3․Բոլորը Եթե արժեք չի փոխանցվում, ապա օգտագործվում է 1- Հաշվեկշռային տարբերակը: |
showZeroRows |
Boolean |
Optional |
Ցույց տալ զրոյական տողերը։ |
openedByDate |
Boolean |
Optional |
Ցույց տալ բացված ըստ ամսաթվերի։ |
subtotals |
Enum |
Optional |
Ենթագումարներ՝ 1․Գործընկեր, 2․Հաշիվ։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
UUID |
Գործընկերոջ ներքին նույնացուցիչ։ |
code |
String |
Գործընկերոջ կոդ։ |
name |
String |
Գործընկերոջ անվանում։ |
status |
String |
Կարգավիճակ։ |
account |
Decimal |
Հաշիվ: |
accountName |
String |
Հաշիվի անվանում: |
analytic1Code |
String |
Անալիտիկ խումբ 1-ի կոդը: |
analytic1Name |
String |
Անալիտիկ խումբ 1-ի անվանումը: |
analytic2Code |
String |
Անալիտիկ խումբ 2-ի կոդը: |
analytic2Name |
String |
Անալիտիկ խումբ 2-ի անվանումը: |
currency |
String |
Լրացվում է արժույթը, ըստ որի կառուցվում է հաշվետվությունը։Պայմանագիր դաշտը լրացված լինելու դեպքում ավտոմատ լրացվում է տվյալ պայմանագրի արժույթը։ |
debitCurrency |
String |
Դեբետային մնացորդ արժույթով: |
creditCurrency |
String |
Կրեդիտային մնացորդ արժույթով: |
debitNCC |
String |
Դեբետային մնացորդ դրամով: |
creditNCC |
String |
Կրեդիտային մնացորդ դրամով: |
outOfBalance |
String |
Հաշվի արտահաշվեկշռային դասվելու հայտանիշ: |
date |
Date(YYYY-MM-DD) |
Մնացորդների ձևավորման ամսաթիվ: |
Օրինակ 1. 31.03.2026թ.-ի դրությամբ նշված գործընկերոջ, նշված հաշվով մնացորդների ստացում` բացված ըստ ամսաթվերի:
|