API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող Գործընկերների մնացորդներ հաշվետվությունը ընդլայնված դաշտերով։
URI |
https://api.armsoft.am/trade/v1/reports/partnersbalances |
URL Swagger |
https://api.armsoft.am/trade/swagger/index.html#/Reports/post_v1_reports_partnersbalances |
GitHub |
https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/reports/partnersbalances.md |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
date |
Date(YYYY-MM-DD) |
*Required |
Մնացորդների ձևավորման ամսաթիվը: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
partnersgroup |
String(5) |
Optional Reference type |
Գործընկերների խումբը։Լրացնելու դեպքում հաշվետվությունում կարտացոլվեն միայն նշված խմբի գործընկերները։ |
partner |
String(20) |
Optional Reference type |
Եթե դաշտի արժեքը լրացված է, ապա հաշվետվությունը կազմվում է միայն տվյալ գործընկերոջ համար, հակառակ դեպքում ՝ գոլոր գործընկերների համար։ Եթե Խումբ դաշտի արժեքը լրացված է, ապա գործընկերների ընտրման միայն տվյալ խմբին պատկանող գործընկերոջը։ |
contract |
String(3) |
Optional |
Դաշտը կարելի է լրացնել, երբ նշված է Գործընկեր։ Լրացնելու դեպքում հաշվետվությունում երևում է միայն տվյալ պայմանագրին վերաբերվող մնացորդը, հակառակ դեպքում՝ մնացորդը բոլոր պայմանագրերում։ |
currency |
String(3) |
Optional Reference type |
Լրացվում է արժույթը, ըստ որի կառուցվում է հաշվետվությունը։Պայմանագիր դաշտը լրացված լինելու դեպքում ավտոմատ լրացվում է տվյալ պայմանագրի արժույթը։ |
reportCurrency |
Enum |
*Required Reference type |
Պարտադիր լրացվող դաշտ է: Եթե դաշտում լրացված է 1 - Ցույց տալ գումարները դրամով արժեքը, ապա հաշվետվությունում բոլոր գումարները երևում են ներկայացված դրամային համարժեքով։ 2 - Ցույց տալ գումարները արժույթով արժեքի դեպքում գումարները երևում են այն արժույթով, որով կատարվել են գործողությունները։ 3 - Ցույց տալ գումարները և դրամով և արժույթով արժեքի դեպքում հաշվետվությունում արտացոլվում են և’ արժույթով գումարները, և’ նրանց դրամային համարժեքները: Եթե արժեք չի փոխանցվում, ապա օգտագործվում է 1- Ցույց տալ գումարները դրամով արժեքը: |
openedByContracts |
Boolean |
Optional |
True արժեքի դեպքում հաշվետվությունում տարբեր պայմանագրերի շրջանակներում մնացորդները երևում են առանձին տողերով։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Decimal |
Գործընկերոջ ներքին նույնացուցիչ։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն՝ առկա են հաջորդ էջեր։ |
code |
String |
Գործընկերոջ կոդ։ |
name |
String |
Գործընկերոջ անվանում։ |
status |
String |
Կարգավիճակ։ |
contractCode |
String |
Պայմանագրի կոդ։ |
contractName |
String |
Պայմանագրի անվանում։ |
contractDate |
Date(YYYY-MM-DD) |
Պայմանագրի կնքման ամսաթիվ։ |
currency |
String |
Լրացվում է արժույթը, ըստ որի կառուցվում է հաշվետվությունը։Պայմանագիր դաշտը լրացված լինելու դեպքում ավտոմատ լրացվում է տվյալ պայմանագրի արժույթը։ |
balance |
String |
Մնացորդը դրամով։ |
balanceCurrency |
Decimal |
Մնացորդը արժույթով։ |
Օրինակ 1. 31.01.2026թ.-ի դրությամբ նշված գործընկերոջ մնացորդների ստացում (001 պայմանագրով, AMD արժույթով և ըստ պայմանագրերի բացված)
|