Բոնուսների մնացորդներ |
  
|
Բոնուսների մնացորդներ |
|
API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող բոնուսների մնացորդներ հաշվետվությունը։
URI |
https://api.armsoft.am/trade/v1/reports/bonusbalances |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 |
Պարտադիր լրացվող ամսաթիվ տիպի դաշտ է: Հաշվետվությունում կարտացոլվեն բոնուսների մնացորդները նշված օրվա դրությամբ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
partnerGroup |
String(5) |
Optional Reference type |
Գործընկերների խումբը: Լրացնելու դեպքում հաշվետվությունում կարտացոլվեն միայն նշված խմբի գործընկերները: |
partner |
String(20) |
Optional Reference type |
Եթե դաշտի արժեքը լրացված է, ապա հաշվետվությունը կազմվում է միայն տվյալ գործընկերոջ համար, հակառակ դեպքում` բոլոր գործընկերների համար։ Եթե Խումբ դաշտի արժեքը լրացված է, ապա գործընկերների ընտրման ցուցակից կարելի է ընտրել միայն տվյալ խմբին պատկանող գործընկերոջը |
contract |
String(3) |
Optional |
Դաշտը կարելի է լրացնել, երբ նշված է Գործընկեր: Լրացնելու դեպքում հաշվետվությունում երևում է միայն տվյալ պայմանագրին վերաբերող մնացորդը, հակառակ դեպքում` մնացորդը բոլոր պայմանագրերով։ |
openedByContracts |
Boolean |
Optional |
Դրոշակը նշված լինելու դեպքում հաշվետվությունում տարբեր պայմանագրերի շրջանակներում մնացորդները երևում են առանձին տողերով։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
partnerId |
Decimal |
Գործընկերոջ նույնացուցիչ: |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն՝ առկա են հաջորդ էջեր։ |
partnerCode |
String |
Գործընկերոջ կոդ: |
partnerName |
String |
Գործընկերոջ անվանում։ |
contractCode |
String |
Գործընկերոջ պայմանագրի կոդ: |
contractName |
String |
Գործընկերոջ պայմանագրի անվանում: |
contractDate |
Date(YYYY-MM-DD) |
Պայմանագրի կնքման ամսաթիվ։ |
group |
String |
Գործընկերների խումբ: Լրացնելու դեպքում հաշվետվությունում կարտացոլվեն միայն նշված խմբի գործընկերները: |
taxCode |
String |
ՀՎՀՀ։ |
legalAddress |
String |
Իրավաբանական հասցե: |
phoneNumber |
String |
Հեռախոսահամար։ |
balance |
String |
Բոնուսային միավորների մնացորդ: |
GitHub |
https://github.com/armsoft/trade-public-api-docs/blob/main/examples/csharp/reports/bonusbalances.cs |
Օրինակ 1. 31.01.2026թ.-ի դրությամբ նշված գործընկերոջ բոնուսների մնացորդների ստացում` ըստ պայմանագրերի բացված
|
