ՀԴՄ կտրոններ |
  
|
ՀԴՄ կտրոններ |
|
API-ի միջոցով հնարավոր է ստանալ (POST) Վաճառք (Մանրածախ), Վերադարձ գնորդից, Դրամարկղի մուտքի օրդեր և Ելքի օրդեր, Անկանխիկ կանխավճարի մուտք և Անկանխիկ կանխավճարի վերադարձ փաստաթղթերի ցանկը:
URI |
https://api.armsoft.am/accountant/v1/journals/ecrchecks |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Journals/post_v1_journals_ecrchecks |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: @SKq7*ERI]ZIgXvpkWhV' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Հարցման պարամետրեր (Request Body)
Մատյանի ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
startDate |
Date(YYYY-MM-DD) |
*Required |
Ժամանակահատվածի սկզբի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
endDate |
Date(YYYY-MM-DD) |
*Required |
Ժամանակահատվածի վերջի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
pageSize |
Integer |
Optional |
Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
documentTypes [0..n] |
Array |
Optional Reference type |
Փաստաթղթերի տեսակների ցանկ: Ընդունում է հետևյալ արժեքները. 07 - Վաճառք (Մանրածախ), 72 - Վերադարձ գնորդից, 04 - Դրամարկղի մուտքի օրդեր, 05 - Դրամարկղի ելքի օրդեր, 28 - Անկանխիկ կանխավճարի մուտք, 29 - Անկանխիկ կանխավճարի վերադարձ։ |
partner |
String(20) |
Optional Reference type |
Գործընկերոջ կոդ: Մատյանում կընդգրկվեն միայն նշված գործընկերոջ հետ կապված փաստաթղթերը: |
cashDesk |
String(12) |
Optional Reference type |
Դրամարկղի կոդ։ Մատյանում կընդգրկվեն միայն նշված դրամարկղով կատարված գործողությունները: |
showPayments |
Boolean |
Optional |
Ցուցադրում է գումարի մարման ձևերի մասին տողեր։ |
showOutputAmountsAsNegatives |
Boolean |
Optional |
Վերադարձ գնորդից, Դրամարկղի ելքի օրդեր և Անկանխիկ կանխավճարի վերադարձ փաստաթղթերի գումարները արտացոլվում են բացասական նշանով։ |
documentState |
Enum |
Optional |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները. 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 3 - Հեռացված: |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
UUID |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
isn |
UUID |
Փաստաթղթի ներքին նույնացուցիչ։ |
date |
Date(YYYY-MM-DD) |
Փաստաթղթի ստեղծման ամսաթիվ: |
documentNumber |
String |
Փաստաթղթի համար: |
ecrCheckNumber |
String |
Փաստաթղթի տեսակի անվանում։ |
type |
Enum |
Փաստաթղթի տեսակի կոդ։ |
typeName |
String |
Փաստաթղթի տեսակի անվանում։ |
amount |
Decimal |
Փաստաթղթի գումար: |
cashAmount |
Decimal |
Կանխիկով ստացված գումար։ |
nonCashAmount |
Decimal |
Անկանխիկով ստացված գումար։ |
prepaymentAmount |
Decimal |
Կանխավճարից մարվող գումար։ |
receivablesAmount |
Decimal |
Գնորդի պարտք մնացած գումար։ |
state |
Enum |
Փաստաթղթի վիճակի կոդ: |
stateName |
Integer |
Փաստաթղթի վիճակի անվանում։ |
cashDesk |
String |
Դրամարկղի կոդ։ |
partnerId |
Integer |
Գործընկերոջ ներքին նույնացուցիչ: |
partnerCode |
String |
Գործընկերոջ կոդ։ |
partnerName |
String |
Գործընկերոջ անվանում։ |
partnerTaxCode |
String |
Գործընկերոջ ՀՎՀՀ։ |
comment |
String |
Մեկնաբանություն փաստաթղթի վերաբերյալ: |
userName |
String |
Օգտագործողի անունը: Նշվում է այն օգտագործողի անունը, ով վերջինն է աշխատել (գրանցել կամ խմբագրել) տվյալ փաստաթղթի հետ: |
lastChange |
Date(YYYY-MM-DDTHH:mm:ss) |
Փաստաթղթի վերջին խմբագրման ամսաթիվը և ժամը: |
Օրինակ 1. 2026 թ.-ի հունվար ամսվա վաճառքների և վերադարձների փաստաթղթերի ցանկի ստացում
|
Օրինակ 2. 2026 թ.-ի հունվար ամսվա 07 և 72 կոդով փաստաթղթերի տեսակների ցանկի ստացում` ըստ վճարման եղանակների բացված և ելքի գումարները բացասական ցուցադրելով
POST |
|
