API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) Ապրանքների տեղաշարժ փաստաթուղթը։
URI |
https://api.armsoft.am/trade/v1/documents/productsmovement |
GitHub |
https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/documents/productsmovement.md |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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) |
*Required |
Փաստաթղթի ամսաթիվ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
documentNumber |
String(12) |
*Required |
Փաստաթղթի համար: Եթե համարը չի փոխանցվում, ապա գրանցվում է վերջին համարին ավելացնելով 1: |
state |
Enum |
*Required |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները. 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 99 - Հեռացված: Եթե վիճակը չի փոխանցվում, փաստաթուղթը ավտոմատ գրանցված վիճակում է ուղարկվում։ |
storageOutput |
String(5) |
*Required Reference type |
Պահեստի կոդ, որտեղից ելքագրվում են ապրանքները։ |
storageInput |
String(5) |
*Required Reference type |
Պահեստի կոդ, որտեղ մուտքագրվում են ապրանքները։ |
priceType |
String(2) |
Optional Reference type |
Նշվում է, թե ապրանքները մուտքագրելիս համակարգն ինչ տեսակի գներ առաջարկի։ |
comment |
String(255) |
Optional |
Մեկնաբանություն։ |
owner |
String(50) |
Optional Reference type |
Փաստաթղթի հեղինակ։ |
mediator |
String(50) |
Optional Reference type |
Միջնորդ։ |
chiefAccount |
String(100) |
Optional |
Գլխավոր հաշվապահի Ա.Ա.Հ։ |
allowed |
String(50) |
Optional |
Տեղաշարժը թույլատրող աշխատակցի Ա.Ա.Հ.։ |
bookNumber |
String(10) |
Optional |
Փաստաթղթի գրանցման գրքի համար (չի կիրառվում): |
bookPage |
Integer |
Optional |
Գրանցման գրքում էջի համար (չի կիրառվում): |
bookLine |
Integer |
Optional |
Գրանցման գրքի էջում տողի համար (չի կիրառվում): |
taxExportType |
Enum |
Optional |
Հաշվարկային փաստաթղթի դուրսգրման եղանակ։ Ընդունում է հետևյալ արժեքները․ 1- էլեկտրոնային, 2-թղթային: |
taxInvoiceSeries |
String(1) |
Optional |
Հարկային մարմնի կողմից ստացված սերիա: |
taxInvoiceNumber |
String(10) |
Optional |
Հարկային մարմնի կողմից ստացված համար: |
submissionDate |
Date(YYYY-MM-DD) |
Optional |
Հարկային հաշվի դուրսգրման ամսաթիվը։ |
transportationMethod |
String(255) |
Optional |
Նյութական արժեքների տեղափոխման եղանակ: |
vehicle |
Boolean |
Optional |
Ավտոտրանսպորտային միջոց։ |
licensePlate |
String(20) |
*Conditional required |
Պետհամարանիշ: |
baseDocumentISN |
UUID(50) |
Optional |
Հիմք փաստաթղթի նույնացուցիչ։ |
productsList [0..n] |
Array |
*Required |
Ապրանքների և ծառայությունների անվանացուցակ (մասսիվ): Անվանացուցակը պետք է պարունակի ապրանքի կամ ծառայութան առնվազն մեկ տող։ |
Անվանացուցակի տողի դաշտերը (itemList)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
id |
Integer |
System defined |
Ապրանքի ներքին նույնացուցիչ։ |
code |
String(20) |
*Required Reference type |
Ապրանքի կոդ։ |
name |
String(200) |
Read only |
Ապրանքի անվանում։ |
fullName |
String(255) |
Read only |
Ապրանքի լրիվ անվանում։ |
unit |
String(3) |
*Required Reference type |
Ապրանքի չափման միավորի կոդ։ |
unitAbbreviation |
String(6) |
Read only |
Ապրանքի չափման միավորի հապավում։ |
quantity |
Decimal |
*Required |
Տեղաշարժվող քանակ։ |
salePrice |
Decimal |
*Required |
Վաճառքի գին։ |
saleAmount |
Decimal |
Optional |
Վաճառքի գումար։ |
discountedPrice |
Decimal |
Optional |
Ապրանքի զեղչված գին։ |
description |
String(50) |
Optional |
Ապրանքի նկարագրություն։ |
rowNumber |
Integer |
System defined |
Տողի համար։ |
rowId |
Integer |
System defined |
Տողի ներքին նույնացուցիչ։ |
Օրինակ 1. Ապրանքների տեղաշարժ փաստաթղթի ստեղծում (պարտադիր դաշտերով)
|
Օրինակ 2. Ապրանքների տեղաշարժ փաստաթղթի ստեղծում (լրացուցիչ դաշտերով)
POST |
|
Օրինակ 3. Նշված isn-ով Ապրանքների տեղաշարժ փաստաթղթի ստացում
|
Օրինակ 4. Նշված isn-ով Ապրանքների տեղաշարժ փաստաթղթի դաշտերի խմբագրում
|
Օրինակ 5. Նշված isn-ով Ապրանքների տեղաշարժ փաստաթղթի հեռացում
|