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