Գործընկերների գործառնությունների մատյան |
  
|
Գործընկերների գործառնությունների մատյան |
|
API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող Գործընկերների գործանությունների մատյան հաշվետվությունը:
URI |
https://api.armsoft.am/accountant/v1/reports/partnerstransactions |
URL Swagger |
https://api.armsoft.am/accountant/swagger/index.html#/Reports/post_v1_reports_partnerstransactions |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
debitPartnerGroup |
String(5) |
Optional Reference type |
Գործառնությանը մասնակցող դեբետ հաշվի գործընկերոջ խմբի կոդը։ |
creditPartnerGroup |
String(5) |
Optional Reference type |
Գործառնությանը մասնակցող կրեդիտ հաշվի գործընկերոջ խմբի կոդը։ |
partnersGroupANDCondition |
Boolean |
Optional |
True արժեքի դեպքում մատյանը ձևավորելիս հաշվի են առնվում Գործընկերոջ Խմբի և' դեբետ, և' կրեդիտ արժեքները: |
debitPartner |
String(20) |
Optional Reference type |
Գործառնությանը մասնակցող դեբետ հաշվի գործընկերոջ կոդը։ |
creditPartner |
String(20) |
Optional Reference type |
Գործառնությանը մասնակցող կրեդիտ հաշվի գործընկերոջ կոդը։ |
partnersANDCondition |
Boolean |
Optional |
True արժեքի դեպքում մատյանը ձևավորելիս հաշվի են առնվում Գործընկերոջ և' դեբետ, և' կրեդիտ արժեքները: |
debitAccount |
String(12) |
Optional Reference type |
Գործառնությանը մասնակցող դեբետ հաշվի համարը։ |
creditAccount |
String(12) |
Optional Reference type |
Գործառնությանը մասնակցող կրեդիտ հաշվի համարը։ |
accountsANDCondition |
Boolean |
Optional |
True արժեքի դեպքում մատյանը ձևավորելիս հաշվի են առնվում հաշվի և' դեբետ, և' կրեդիտ արժեքները: |
debitCurrency |
String(3) |
Optional Reference type |
Գործառնությանը մասնակցող դեբետ հաշվի արժույթի կոդը։ |
creditCurrency |
String(3) |
Optional Reference type |
Գործառնությանը մասնակցող կրեդիտ հաշվի արժույթի կոդը։ |
currenciesANDCondition |
Boolean |
Optional |
True արժեքի դեպքում մատյանը ձևավորելիս հաշվի են առնվում արժույթի և' դեբետ, և' կրեդիտ արժեքները: |
documentTypes [] |
Array |
Optional Reference type |
Նշվում է փաստաթղթի տեսակը: Կարելի է նշել մեկ կամ մի քանի փաստաթղթի տեսակներ: Մատյանում կընդգրկվեն նշված փաստաթղթերի տեսակի գործառնությունները, իսկ դաշտը դատարկ լինելու դեպքում` բոլոր գործառնությունները: |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
isn |
UUID |
Փաստաթղթի ներքին նույնացուցիչ։ |
date |
Date(YYYY-MM-DD) |
Փաստաթղթի ամսաթիվ։ |
documentNumber |
String |
Փաստաթղթի համար։ |
type |
Enum |
Փաստաթղթի տեսակի կոդ։ |
typeName |
String |
Փաստաթղթի տեսակի անվանում։ |
debitPartnerGroup |
String |
Դեբետ գործընկերոջ խմբի կոդ։ |
debitPartnerGroupName |
String |
Դեբետ գործընկերոջ խմբի անվանում։ |
debitPartner |
String |
Դեբետ գործընկերոջ կոդ։ |
debitPartnerName |
String |
Դեբետ գործընկերոջ անվանում։ |
debitPartnerTaxCode |
String |
Դեբետ գործընկերոջ ՀՎՀՀ։ |
debitAccount |
String |
Դեբետ հաշիվ։ |
debitAccountType |
Enum |
Դեբետ հաշվի տեսակ։ |
debitCurrency |
String |
Դեբետ հաշվի արժույթի կոդ։ |
creditPartnerGroup |
String |
Կրեդիտ գործընկերոջ խմբի կոդ։ |
creditPartnerGroupName |
String |
Կրեդիտ գործընկերոջ խմբի անվանում։ |
creditPartner |
String |
Կրեդիտ գործընկերոջ կոդ։ |
creditPartnerName |
String |
Կրեդիտ գործընկերոջ անվանում։ |
creditPartnerTaxCode |
String |
Կրեդիտ գործընկերոջ ՀՎՀՀ։ |
creditAccount |
String |
Կրեդիտ հաշիվ։ |
creditAccountType |
Enum |
Կրեդիտ հաշվի տեսակ։ |
creditCurrency |
String |
Կրեդիտ հաշվի արժույթ։ |
amount |
Decimal |
Գումար դրամով։ |
currencyAmount |
Decimal |
Գումար արժույթով։ |
comment |
String |
Մեկնաբանություն։ |
userName |
String |
Օգտագործող։ |
systemGenerated |
Boolean |
Համակարգային գործառնության հայտանիշ։ |
Օրինակ 1. 2026 թ.-ի մարտ ամսվա գործընկերների գործառնությունների մատյանի ստացում
|
