ՀԴՄ կտրոններ

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

ՀԴՄ կտրոններ

Previous pageReturn to chapter overviewNext page

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

API-ի միջոցով հնարավոր է ստանալ (POST) Վաճառք (Կտրոն), Վերադարձ (կտրոն), Վերադարձ գնորդից, Մուտքի օրդեր և Ելքի օրդեր փաստաթղթերի ցանկը:

 

URI

https://api.armsoft.am/trade/v1/journals/ecrchecks

URL Swagger

https://api.armsoft.am/trade/swagger/index.html#/Journals/post_v1_journals_ecrchecks

GitHub

https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/journals/ecrchecks.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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

startDate

Date(YYYY-MM-DD)

*Required

Ժամանակահատվածի սկզբի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը:

endDate

Date(YYYY-MM-DD)

*Required

Ժամանակահատվածի վերջի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը:

documentTypes [0..n]

Array

Optional

Reference type

Փաստաթղթերի տեսակների ցանկ: Ընդունում է հետևյալ արժեքները.

18 - Վաճառք (Կտրոն),

15 - Վերադարձ գնորդից,

38 - Վերադարձ (Կտրոն),

02 - Դրամարկղի մուտքի օրդեր,

03 - Դրամարկղի ելքի օրդեր:

partnerCode

String(20)

Optional

Reference type

Գործընկերոջ կոդ: Մատյանում կընդգրկվեն միայն նշված գործընկերոջ հետ կապված փաստաթղթերը:

itemCode

String(20)

Optional

Reference type

Ապրանքի (ծառայության) կոդ։ Մատյանում կընդգրկվեն միայն նշված ապրանքի հետ կապված փաստաթղթերը:

storageCode

String(5)

Optional

Reference type

Պահեստի կոդը։ Մատյանում կընդգրկվեն նշված պահեստի հետ կապված փաստաթղթերը:

cashDeskCode

String(8)

Optional

Reference type

Դրամարկղի կոդը։ Մատյանում կընդգրկվեն նշված դրամարկղի հետ կապված փաստաթղթերը:

employeeCode

String(12)

Optional

Reference type

Աշխատակցի կոդ։ Մատյանում կընդգրկվեն միայն նշված աշխատակցի հետ կապված փաստաթղթերը:

showPayments

Boolean

Optional

Ցուցադրում է գումարի մարման ձևերի մասին տողեր։

showOutputAmountsAsNegatives

Boolean

Optional

Վերադարձ գնորդից և Վերադարձ կտրոն փաստաթղթերի գումարները արտացոլվում են բացասական նշանով։

documentState

Enum

Optional

Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները

0 - Գրանցված կամ սևագիր,

1 - Սևագիր,

2 - Գրանցված,

3 - Հեռացված:

Արժեք չտալու դեպքում համակարգը կվերադարձնի բոլոր փաստաթղթերը անկախ վիճակից։

owner

String(50)

Optional

Reference type

Մատյանում կընդգրկվեն միայն նշված Հեղինակի փաստաթղթերը: Դաշտը դատարկ լինելու դեպքում կընդգրկվեն բոլոր հեղինակների փաստաթղթերը:

 

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

Անվանում

Տեսակ

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

id

Integer

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

hasMore

Boolean

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

data[]

Array

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

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

Անվանում

Տեսակ

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

isn

UUID

Փաստաթղթի ներքին նույնացուցիչ։

date

Date(YYYY-MM-DD)

Փաստաթղթի ստեղծման ամսաթիվ:

dayOrderNumber

Integer

Փաստաթղթի օրվա հերթական համար։

documentNumber

String

Փաստաթղթի համար:

ecrCheckNumber

String

ՀԴՄ կտրոնի համար։

type

Enum

Փաստաթղթի տեսակի կոդ։ Աղյուսակում նշված են բոլոր տեսակի փաստաթղթերի կոդերը։

typeName

String

Փաստաթղթի տեսակի անվանում։

currency

String

Փաստաթղթի արժույթ։

amount

Decimal

Փաստաթղթի գումար:

state

Integer

Փաստաթղթի վիճակի կոդ:

stateName

String

Փաստաթղթի վիճակի անվանում։

storageCode

String

Պահեստի կոդ։

storageName

String

Պահեստի անվանում։

information

String

Այս դաշտում լրացվում է տվյալ փաստաթղթի հետ կապված առավել կարևոր տեղեկություն։ Աղյուսակում նշված է, թե յուրաքանչյուր փաստաթղթի համար ինչ տեղեկություն է լրացվում այս սյունում։

comment

String

Մեկնաբանություն փաստաթղթի վերաբերյալ:

partnerId

Integer

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

partnerCode

String

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

partnerName

String

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

partnerTaxCode

String

Գործընկերոջ ՀՎՀՀ:

employeeCode

String

Աշխատակցի կոդ։

employeeName

String

Աշխատակցի անվանում։

userName

String

Օգտագործողի անունը: Նշվում է այն օգտագործողի անունը, ով վերջինն է աշխատել (գրանցել կամ խմբագրել) տվյալ փաստաթղթի հետ:

lastChange

Date(YYYY-MM-DDTHH:mm:ss)

Փաստաթղթի վերջին խմբագրման ամսաթիվը և ժամը:

owner

String

Փաստաթղթի հեղինակը։

information դաշտում վերադարձվող տեղեկության նկարագրությունը

Փաստաթուղթ

Տեղեկություն

Վաճառք (Կտրոն)

Դրամարկղի անվանումը:

Վերադարձ գնորդից

Գնորդի անվանումը:

Վերադարձ (Կտրոն)

Դրամարկղի անվանումը:

Դրամարկղի մուտքի օրդեր

Վճարող դաշտում լրացված տեքստը:

Դրամարկղի ելքի օրդեր

Տրամադրել դաշտում լրացված տեքստը:

 

GitHub

https://github.com/armsoft/trade-public-api-docs/blob/main/examples/csharp/journals/list-ecrchecks.cs

Օրինակ 1. 2026թ. հունվար ամսվա ՀԴՄ կտրոններ մատյանում ընդգրված բոլոր փաստաթղթերի ստացում

POST

 

Օրինակ 2. 2026թ. հունվար ամսվա 03 և 18 կոդերով փաստաթղթերի ցանկի ստացում (բացված ըստ վճարման եղանակների և ելքերի գումարների բացասական ցուցադրմամբ)

POST