API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) Վաճառք (Կտրոն) փաստաթուղթը:
URI |
https://api.armsoft.am/trade/v1/documents/sale |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&K.f2(=0#biWc:' |
Վաճառք (Կտրոն) օբյեկտի ատրիբուտներ (Object Attributes)
Ստորև ներկայացված է օբյեկտի ատրիբուտների նկարագրությունը.
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
isn |
UUID |
|
Փաստաթղթի նույնացուցիչ: Պարտադիր է GET, PUT, DELETE հարցումների դեպքում։ Եթե POST հարցման ժամանակ UUID-ը չի փոխանցվում, սերվերը այն ավտոմատ գեներացնում է և վերադարձնում պատասխանում։ |
date |
Date(YYYY-MM-DD) |
|
Փաստաթղթի ամսաթիվ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
documentNumber |
String(12) |
Փաստաթղթի համար: Եթե համարը չի փոխանցվում, ապա գրանցվում է վերջին համարին ավելացնելով 1: |
|
state |
Enum |
Փաստաթղթի վիճակի բնութագիր: Գրանցված, սևագիր, հեռացված։ |
|
storage |
String(5) |
|
Պահեստի կոդ: |
cashDesk |
String(8) |
|
Դրամարկղի կոդ: |
cashierShiftNumber |
String(12) |
Հերթափոխի կոդ: Գրանցվում է նշված դրամարկղի բաց հերթափոխի կոդը: Եթե բաց հերթափոխ չի հայտնաբերվում, վերագրվում է դատարկ արժեք: |
|
ecrCheckNumber |
String(8) |
ՀԴՄ կտրոնի համար: |
|
prepaymentECRCheckNumber |
String(8) |
Կանխավճարի ՀԴՄ կտրոնի համար։ |
|
customer |
String(20) |
|
Գնորդի կոդ: |
customerContract |
String(3) |
Գնորդի պայմանագրի կոդ։ |
|
seller |
String(12) |
|
Վաճառողի կոդ: |
printExpenseConfirmingCheck |
Boolean |
Տպել ծախս հիմնավորող ՀԴՄ կտորոնը։ |
|
cashAmount |
Decimal |
cashAmount, nonCashAmount, bonusAmount, creditAmount և prepaymentAmount դաշտերի հանրագումարը պետք է հավասար լինի վաճառքի հանրագումարին (անվանացուցակի (itemsList) բոլոր տողերի amount սյան հանրագումարին): Դաշտերի արժեքները չեն կարող լինել բացասական։ Եթե նշված են nonCashAmount, bonusAmount, creditAmount և prepaymentAmount դաշտերի արժեքները և չի նշված cashAmount, ապա մնացած գումարը կվերագրվի cashAmount պարամետրին: |
|
nonCashAmount |
Decimal |
Անկանխիկ վճարվող գումար: |
|
posBank |
String(20) |
POS-տերմինալ տրամադրող բանկի կոդ: |
|
posContract |
String(3) |
POS-տերմինալի տրամադրման պայմանագիր: |
|
connectedDevice |
Enum |
Միացված սարք։ Ընդունում է հետևյալ արժեքները․ 1-ՀԴՄ-ի POS տերմինալ, 2-ARCUS 2 POS (Ingenico/SUNMI), 3-Possoft Pay POS (Feitian) |
|
paymentSystem |
Enum |
Վճարային համակարգ։ Ընդունում է հետևյալ արժեքները․ 1-ARCA, 2-VISA, 3-MASTER, 4-AMEX, 5-PayX, 6-Idram, 7-InecoPay, 9-Telcell, 10-MIR, 11-Քարտային վճարում |
|
creditAmount |
Decimal |
Ապառիկ գումար: |
|
prepaymentAmount |
Decimal |
Կանխավճարով մարվող գումար: |
|
prepaymentCustomer |
String(20) |
Կանխավճարի գործընկեր: |
|
prepaymentContract |
String(3) |
Կանխավճարի գործընկերոջ պայմանագիր: |
|
changeAmount |
Decimal |
Մանր: |
|
bonusAmount |
Decimal |
Բոնուսով մարվող գումար: |
|
addedBonus |
Decimal |
Հաճախորդի բոնուսային միավորներին ավելացվող գումար։ |
|
accumulatedBonus |
Decimal |
Կուտակված բոնուս։ |
|
vatCalculationType |
Enum |
ԱԱՀ-ի հաշվարկի ձև. 1 - ԱԱՀ-ով, 2 - ԱԱՀ-ն այդ թվում, 3 - Առանց ԱԱՀ, 4 - Զրոյական ԱԱՀ: |
|
priceType |
String(2) |
|
Գնի տեսակի կոդ։ |
discountPriceType |
String(2) |
|
Զեղչի գնի տեսակի կոդ։ |
comment |
String(255) |
Փաստաթղթի մեկնաբանություն։ |
|
owner |
String(50) |
|
Հեղինակի կոդ: |
discountPercent |
Decimal |
Զեղչի տոկոս: |
|
itemList [0..n] |
Array |
Ապրանքների և ծառայությունների անվանացուցակ (մասսիվ): Անվանացուցակը պետք է պարունակի ապրանքի կամ ծառայութան առնվազն մեկ տող։ |
Հաշվարկվում է համակարգի բիզնես տրամաբանությամբ․ ձեր կողմից փոխանցված ցանկացած արժեք կփոփոխվի համակարգի կողմից։
Անվանացուցակի տողի դաշտերը (itemList)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
type |
Enum |
Տողի տեսակ (1-Ապրանք, 2-Ծառայություն): |
|
storage |
String(5) |
Պահեստի կոդ: |
|
barcode |
String(25) |
Գծիկավոր կոդ: |
|
id |
Integer |
Ապրանքի կամ ծառայության ներքի կոդ: |
|
code |
String(20) |
Ապրանքի կամ ծառայության կոդ: |
|
name |
String(200) |
Ապրանքի կամ ծառայության անվանում: Ծառայության դեպքում անվանումը կարելի է վերագրել։ Ապրանքի դեպքումը դաշտի արժեքը կանտեսվի։ |
|
unit |
String(3) |
|
Ապրանքի կամ ծառայության չափման միավորի կոդ։ |
unitAbbreviation |
String(6) |
Ապրանքի կամ ծառայության չափման միավորի հապավում։ |
|
quantity |
Decimal |
Ապրանքի քանակը կամ ծառայության ծավալ: |
|
salePrice |
Decimal |
Վաճառքի գին: |
|
discountPercent |
Decimal |
Զեղչի տոկոս: |
|
discountedPrice |
Decimal |
Զեղչված գին: |
|
discountedAmount |
Decimal |
Զեղչված գումար: |
|
discountAmount |
Decimal |
Զեղչի գումար: |
|
usedBonus |
Decimal |
Օգտագործված բոնուս: |
|
accumulatedBonus |
Decimal |
Կուտակված բոնուս: |
|
vat |
Boolean |
ԱԱՀ-ով հարկման հայտանիշ: |
|
description |
String(50) |
Տողի նկարագրություն: |
|
deleted |
Boolean |
Տողի հեռացված լինելու հայտանիշ։ |
|
gift |
Boolean |
Նվերի հայտանիշ։ |
|
rowNumber |
Integer |
Տողի համար։ |
|
rowId |
Integer |
Տողի ներքին նույնացուցիչ։ |
|
cpaClassifier |
String(12) |
Ապրանքի դասակարգիչն է: Ընդունում է արժեքներ արտադրանքի դասակարգումն ըստ գործունեության տեսակների (ԱԴԳՏ) դասակարգիչների ցանկից: |
|
markingList[] |
Array |
Դրոշմավորման ծածկագրերի ցուցակ (մասսիվ): |
|
|
|
|