Գործընկերների մնացորդներ

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

Գործընկերների մնացորդներ

Previous pageReturn to chapter overviewNext page

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

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

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

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

 

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

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

Անվանում

Տեսակ

Կիրառումը

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

date

Date(YYYY-MM-DD)

api_required

Մնացորդների ձևավորման ամսաթիվը:

partnersgroup

String(5)

api_optional

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

partner

String(20)

api_optional

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

contract

String(3)

api_optional

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

currency

String(3)

api_optional

Լրացվում է արժույթը, ըստ որի կառուցվում է հաշվետվությունը։Պայմանագիր դաշտը լրացված լինելու դեպքում ավտոմատ լրացվում է տվյալ պայմանագրի արժույթը։

reportCurrency

Enum

api_optional

Պարտադիր լրացվող դաշտ է: Եթե դաշտում լրացված է 1 - Ցույց տալ գումարները դրամով արժեքը, ապա հաշվետվությունում բոլոր գումարները երևում են ներկայացված դրամային համարժեքով։ 2 - Ցույց տալ գումարները արժույթով արժեքի դեպքում գումարները երևում են այն արժույթով, որով կատարվել են գործողությունները։ 3 - Ցույց տալ գումարները և դրամով և արժույթով արժեքի դեպքում հաշվետվությունում արտացոլվում են և’ արժույթով գումարները, և’ նրանց դրամային համարժեքները:

openedByContracts

Boolean

api_optional

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

 

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

Անվանում

Տեսակ

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

id

Decimal

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

code

String

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

name

String

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

status

String

Կարգավիճակ։

contractCode

String

Պայմանագրի կոդ։

contractName

String

Պայմանագրի անվանում։

contractDate

Date(YYYY-MM-DD)

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

currency

String

Լրացվում է արժույթը, ըստ որի կառուցվում է հաշվետվությունը։Պայմանագիր դաշտը լրացված լինելու դեպքում ավտոմատ  լրացվում է տվյալ պայմանագրի արժույթը։

balance

String

Մնացորդը դրամով։

balanceCurrency

Decimal

Մնացորդը արժույթով։

 

POST