API-ի միջոցով հնարավոր է ստանալ (POST) Վաճառք (Կտրոն), Վերադարձ (կտրոն), Վերադարձ գնորդից, Մուտքի օրդեր և Ելքի օրդեր փաստաթղթերի ցանկը:
URI |
https://api.armsoft.am/trade/v1/journals/ecrchecks |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Հարցման պարամետրեր (Request Body)
Մատյանի ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
startDate |
Date(YYYY-MM-DD) |
Ժամանակահատվածի սկզբի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում: |
|
endDate |
Date(YYYY-MM-DD) |
Ժամանակահատվածի վերջի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշվածժամանակահատվածում: |
|
documentTypes [0..n] |
Array |
Փաստաթղթերի տեսակների ցանկ: Ընդունում է հետևյալ արժեքները` 18 - Վաճառք (Կտրոն), 15 - Վերադարձ գնորդից, 38 - Վերադարձ (Կտրոն), 02 - Դրամարկղի մուտքի օրդեր, 03 - Դրամարկղի ելքի օրդեր: |
|
partnerCode |
String(20) |
Գործընկերոջ կոդ: Մատյանում կընդգրկվեն միայն նշված գործընկերոջ հետ կապված փաստաթղթերը: |
|
itemCode |
String(20) |
Ապրանքի (ծառայության) կոդ։ Մատյանում կընդգրկվեն միայն նշված ապրանքի հետ կապված փաստաթղթերը: |
|
storageCode |
String(5) |
Պահեստի կոդը։ Մատյանում կընդգրկվեն նշված պահեստի հետ կապված փաստաթղթերը: |
|
cashDeskCode |
String(8) |
Դրամարկղի կոդը։ Մատյանում կընդգրկվեն նշված դրամարկղի հետ կապված փաստաթղթերը: |
|
employeeCode |
String(12) |
Աշխատակցի կոդ։ Մատյանում կընդգրկվեն միայն նշված աշխատակցի հետ կապված փաստաթղթերը: |
|
showPayments |
Boolean |
Ցուցադրում է գումարի մարման ձևերի մասին տողեր։ |
|
showOutputAmountsAsNegatives |
Boolean |
Վերադարձ գնորդից և Վերադարձ կտրոն փաստաթղթերի գումարները արտացոլվում են բացասական նշանով։ |
|
documentState |
Enum |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 3 - Հեռացված: |
|
owner |
String(50) |
Մատյանում կընդգրկվեն միայն նշված Հեղինակի փաստաթղթերը: Դաշտը դատարկ լինելու դեպքում կընդգրկվեն բոլոր հեղինակների փաստաթղթերը: |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
isn |
UUID |
Փաստաթղթի ներքին նույնացուցիչ։ |
date |
Date(YYYY-MM-DD) |
Փաստաթղթի ստեղծման ամսաթիվ: |
dayOrderNumber |
Integer |
Փաստաթղթի օրվա հերթական համար։ |
documentNumber |
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 դաշտում վերադարձվող տեղեկության նկարագրությունը
Փաստաթուղթ |
Տեղեկություն |
Վաճառք (Կտրոն) |
Դրամարկղի անվանումը: |
Վերադարձ գնորդից |
Գնորդի անվանումը: |
Վերադարձ (Կտրոն) |
Դրամարկղի անվանումը: |
Դրամարկղի մուտքի օրդեր |
Վճարող դաշտում լրացված տեքստը: |
Դրամարկղի ելքի օրդեր |
Տրամադրել դաշտում լրացված տեքստը: |
|
POST |
|