API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) Ապրանքների տեղաշարժ փաստաթուղթը։
URI |
https://api.armsoft.am/trade/v1/documents/sale |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Ապրանքների տեղաշարժ օբյեկտի ատրիբուտներ (Object Attributes)
Ստորև ներկայացված է օբյեկտի ատրիբուտների նկարագրությունը.
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
isn |
UUID |
|
Փաստաթղթի նույնացուցիչ: Պարտադիր է GET, PUT, DELETE հարցումների դեպքում։ POST հարցման ժամանակ UUID-ը չի փոխանցվում, սերվերը այն ավտոմատ գեներացնում է և վերադարձնում պատասխանում։ |
date |
Date(YYYY-MM-DD) |
Փաստաթղթի ամսաթիվ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը: |
|
documentNumber |
String(12) |
Փաստաթղթի համար: Եթե համարը չի փոխանցվում, ապա գրանցվում է վերջին համարին ավելացնելով 1: |
|
state |
Enum |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները. 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 3 - Հեռացված: |
|
storageOutput |
String(5) |
Պահեստի կոդ, որտեղից ելքագրվում են ապրանքները։ |
|
storageInput |
String(5) |
Պահեստի կոդ, որտեղ մուտքագրվում են ապրանքները։ |
|
priceType |
String(2) |
Նշվում է, թե ապրանքները մուտքագրելիս համակարգն ինչ տեսակի գներ առաջարկի։ |
|
comment |
String(255) |
Մեկնաբանություն։ |
|
owner |
String(50) |
Փաստաթղթի հեղինակ։ |
|
mediator |
String(50) |
Միջնորդ։ |
|
chiefAccount |
String(100) |
Գլխավոր հաշվապահի Ա.Ա.Հ։ |
|
allowed |
String(50) |
Տեղաշարժը թույլատրող աշխատակցի Ա.Ա.Հ.։ |
|
bookNumber |
String(10) |
Փաստաթղթի գրանցման գրքի համար (չի կիրառվում): |
|
bookPage |
Integer |
Գրանցման գրքում էջի համար (չի կիրառվում): |
|
bookLine |
Integer |
Գրանցման գրքի էջում տողի համար (չի կիրառվում): |
|
taxExportType |
Enum |
Հաշվարկային փաստաթղթի դուրսգրման եղանակ։ Ընդունում է հետևյա արժեքները․ 1- էլեկտրոնային, 2-թղթային: |
|
taxInvoiceSeries |
String(1) |
Հարկային մարմնի կողմից ստացված սերիա: |
|
taxInvoiceNumber |
String(10) |
Հարկային մարմնի կողմից ստացված համար: |
|
submissionDate |
Date(YYYY-MM-DD) |
Հարկային հաշվի դուրսգրման ամսաթիվը։ |
|
transportationMethod |
String(255) |
Նյութական արժեքների տեղափոխման եղանակ: |
|
vehicle |
Boolean |
Ավտոտրանսպորտային միջոց։ |
|
licensePlate |
String(20) |
Պետհամարանիշ: |
|
baseDocumentISN |
UUID(50) |
Հիմք փաստաթղթի նույնացուցիչ։ |
|
productsList [0..n] |
Array |
Ապրանքների և ծառայությունների անվանացուցակ (մասսիվ): Անվանացուցակը պետք է պարունակի ապրանքի կամ ծառայութան առնվազն մեկ տող։ |
Անվանացուցակի տողի դաշտերը (itemList)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
id |
Integer |
Ապրանքի ներքին նույնացուցիչ։ |
|
code |
String(20) |
Ապրանքի կոդ։ |
|
name |
String(200) |
Ապրանքի անվանում։ |
|
fullName |
String(255) |
Ապրանքի լրիվ անվանում։ |
|
unit |
String(3) |
Ապրանքի չափման միավորի կոդ։ |
|
unitAbbreviation |
String(6) |
Ապրանքի չափման միավորի հապավում։ |
|
quantity |
Decimal |
Տեղաշարժվող քանակ։ |
|
salePrice |
Decimal |
Վաճառքի գին։ |
|
saleAmount |
Decimal |
Վաճառքի գումար։ |
|
discountedPrice |
Decimal |
Ապրանքի զեղչված գին։ |
|
description |
String(50) |
Ապրանքի նկարագրություն։ |
|
rowNumber |
Integer |
Տողի համար։ |
|
rowId |
Integer |
Տողի ներքին նույնացուցիչ։ |
|
|
|
|