Ծառայությունների ցուցակ

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

Ծառայությունների ցուցակ

Previous pageReturn to chapter overviewNext page

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

API-ի միջոցով հնարավոր է ստանալ (POST) Ծառայությունների ցուցակը։

URI

https://api.armsoft.am/accountant/v1/directories/services/list

URL Swagger

https://api.armsoft.am/accountant/swagger/index.html#/Services/post_v1_directories_services_list

Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

  codes

Array

Optional

Reference type

Ծառայությունների կոդերը։

  lastModifiedDate

Enum

Optional

Վերջին խմբագրման ամսաթիվը։

 

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

Անվանում

Տեսակ

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

id

Integer

Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։

hasMore

Boolean

Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

data[]

Array

Տվյալների ցուցակ (մասսիվ),  որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։

Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)

Անվանում

Տեսակ

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

id

Integer

Ծառայության ներքին նույնացուցիչ։

code

String

Ծառայության կոդ։ Արժեք չտալու դեպքում ընդունում է ծրագրից գեներացված հերթական համարը։

name

String

Ծառայության անվանում։

fullName

String

Ծառայության լրիվ անվանում։

unitMeasure

String

Ծառայության չափման միավորի կոդ։

unitMeasureAbbreviation

String

Ծառայության չափման միավորի հապավում:

cpaClassifier

String

Ծառայության ԱՏԳԱԱ դասակարգիչ։

account

String

Ծառայության հաշվառման հաշիվ։

revenueAccount

String

Ծառայության վաճառքից հասույթի հաշիվ։

retailRevenueAccount

String

Ծառայության մանրածախ վաճառքից հասույթի հաշիվ։

revenueAdjustmentAccount

String

Ծառայության վաճառքից հետ վերադարձի հասույթի ճշգրտման հաշիվ։

wholePrice

Decimal

Ծառայության մեծածախ գին դրամով։

retailPrice

Decimal

Ծառայության մանրածախ գին դրամով։

barcode

String

Ծառայության գծիկավոր կոդ։

vat

Boolean

Ծառայության ԱԱՀ-ով հարկման հայտանիշ։

 

 

Օրինակ 1. Ծառայությունների ցուցակի ստացում

POST