Բոնուսների մնացորդներ

Ուղղորդիչ:  REST API (ամպային տարբերակ) > Հաշվետվություններ >

Բոնուսների մնացորդներ

Previous pageReturn to chapter overviewNext page

Բացել/Փակել թաքցված տեքստը

API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող  բոնուսների մնացորդներ հաշվետվությունը։

 

URI

https://api.armsoft.am/trade/v1/reports/bonusbalances

URL Swagger

https://api.armsoft.am/trade/swagger/index.html#/Reports/post_v1_reports_bonusbalances

Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:

-H 'apiKey: hJk:|^&99։՛(=0#biWc:'

 

Հարցման պարամետրեր (Request Body)

Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

date

Date(YYYY-MM-DD)

api_required

Պարտադիր լրացվող ամսաթիվ տիպի դաշտ է: Հաշվետվությունում կարտացոլվեն բոնուսների մնացորդները նշված օրվա դրությամբ:

partnerGroup

String(5)

api_optional

Գործընկերների խումբը: Լրացնելու դեպքում հաշվետվությունում կարտացոլվեն միայն նշված խմբի գործընկերները:

partner

String(20)

api_optional

Եթե դաշտի արժեքը լրացված է, ապա հաշվետվությունը կազմվում է միայն տվյալ գործընկերոջ համար, հակառակ դեպքում` բոլոր գործընկերների համար։ Եթե Խումբ դաշտի արժեքը լրացված է, ապա գործընկերների ընտրման ցուցակից կարելի է ընտրել միայն տվյալ խմբին պատկանող գործընկերոջը

contract

String(3)

api_optional

Դաշտը կարելի է լրացնել, երբ նշված է Գործընկեր: Լրացնելու դեպքում հաշվետվությունում երևում է միայն տվյալ պայմանագրին վերաբերող մնացորդը, հակառակ դեպքում` մնացորդը բոլոր պայմանագրերով։

openedByContracts

Boolean

api_optional

Դրոշակը նշված լինելու դեպքում հաշվետվությունում տարբեր պայմանագրերի շրջանակներում մնացորդները երևում են առանձին տողերով։

 Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)

Անվանում

Տեսակ

Նկարագրություն

partnerId

Decimal

Գործընկերոջ նույնացուցիչ:

partnerCode

String

Գործընկերոջ կոդ:

partnerName

String

Գործընկերոջ անվանում։

contractCode

String

Գործընկերոջ պայմանագրի կոդ:

contractName

String

Գործընկերոջ պայմանագրի անվանում:

contractDate

Date(YYYY-MM-DD)

Պայմանագրի կնքման ամսաթիվ։

group

String

Գործընկերների խումբ: Լրացնելու դեպքում հաշվետվությունում կարտացոլվեն միայն նշված խմբի գործընկերները:

taxCode

String

ՀՎՀՀ։

legalAddress

String

Իրավաբանական հասցե:

phoneNumber

String

Հեռախոսահամար։

balance

String

Բոնուսային միավորների մնացորդ:

 

POST