.API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) Վաճառք (Հաշիվ-Ապրանքագիր) փաստաթուղթը:
URI |
https://api.armsoft.am/trade/v1/documents/invoice |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&K.f2(=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) |
Optional |
Փաստաթղթի համար: Եթե համարը չի փոխանցվում, ապա գրանցվում է վերջին համարին ավելացնելով 1: |
state |
Enum |
Optional |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները. 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 99 - Հեռացված: Եթե վիճակը չի փոխանցվում, փաստաթուղթը ավտոմատ գրանցված վիճակում է ուղարկվում։ |
baseDocumentISN |
UUID |
Optional |
Հիմք փաստաթղթի նույնացուցիչ։ |
customer |
String(20) |
Optional Reference type |
Գնորդի կոդ: |
customerContract |
String(3) |
*Conditional required Reference type |
Գնորդի պայմանագրի կոդ։ Արժեք չուղարկելու դեպքում ավտոմատ լրացվում է գնորդի հիմնական պայմանագրի կոդը։ |
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 |
Հարկային հաշվի դուրսգրման ամսաթիվը։ |
seller |
String(12) |
Optional Reference type |
Վաճառողի կոդ: |
comment |
String(255) |
Optional |
Փաստաթղթի մեկնաբանություն։ |
owner |
String(50) |
Optional Reference type |
Փաստաթուղթը ստեղծող օգտագործողը։ |
currency |
String(3) |
*Required Reference type |
Փաստաթղթի արժույթի կոդ: Եթե արժեք չենք տալիս, ավտոմատ լրացվում է ծրագրի դրույթներում նշված արժեքը։ |
exchangeRate |
Decimal |
*Conditional required |
Արժույթի փոխարժեք: |
exchangeBase |
Decimal |
*Conditional required |
Արժույթի փոխարժեքի պատիկություն: |
vatCalculationType |
Enum |
*Required |
ԱԱՀ-ի հաշվարկի ձև։ Ընդունում է հետևյալ արժեքները. 1 - ԱԱՀ-ով, 2 - ԱԱՀ-ն այդ թվում, 3 - Առանց ԱԱՀ, 4 - Զրոյական ԱԱՀ, 5 - ԱԱՀ-ն այդ թվում 16.67 % Եթե արժեք չենք տալիս, ավտոմատ լրացվում է ծրագրի դրույթներում նշված արժեքը։ |
dealType |
Enum |
Optional |
Դաշտը լրացվում է, եթե փաստաթղթում առկա են ԱԱՀ-ով չհարկվող տողեր: Եթե փաստաթղթում ԱԱՀ-ի հաշվարկի ձևը նշված է ԱԱՀ-ով կամ ԱԱՀ-ն այդ թվում, ապա որպես Գործարքի տեսակ հնարավոր է նշել հետևյալ տարբերակներից մեկը. 1 - ԱԱՀ-ի 0% դրույքաչափով հարկվող, 2 - ԱԱՀ- ից ազատված, 3 - Այլ: Եթե փաստաթղթում ԱԱՀ-ի հաշվարկի ձևը նշված է Առանց ԱԱՀ կամ Զրոյական ԱԱՀ, ապա որպես Գործարքի տեսակ հնարավոր է նշել հետևյալ տարբերակներից մեկը. 1 - Հարկման հատուկ համակարգ, 2 - ԱԱՀ-ից ազատված, 3 - ԱԱՀ-ի 0% դրույքաչափով հարկվող, 4 - ԱԱՀ-ով հարկման օբյեկտ չհամարվող, 5 - Արտահանում, 6 - ԵՏՄ օդային տրանսպորտով արտահանում, 7 - ԱԱՀ չվճարողներ: Դաշտի արժեքը արտահանվում է e-Invoicing: |
priceType |
String(2) |
Optional Reference type |
Նշվում է, թե ինչ գներով են վաճառվում ապրանքները։ |
storage |
String(5) |
*Conditional required Reference type |
Պահեստի կոդ։ Պարտադիր է ուղարկել այն դեպքում, երբ չենք ուղարկում անվանացուցակով։ |
discountPercent |
Decimal |
Optional |
Զեղչի %: |
vatAmount |
Decimal |
Optional |
ԱԱՀ-ի գումար: ԱԱՀ-ի գումարը ավտոմատ հաշվարկվում է ապրանքի վրա նշված ԱԱՀ-ի հաշվարկման բնութագրիչի, ԱԱՀ-ի հաշվարկի ձևի և ընդհանուր գումարի հիման վրա։ |
totalAmount |
Decimal |
Optional |
Ընդհանուր գումար: Ընդհանուր գումարը ավտոմատ է հաշվարկվում տրված գնի և քանակի հիման վրա։ |
supplierName |
String(100) |
Optional |
Մատակարարի անվանում։ |
supplierLegalAddress |
String(100) |
Optional |
Մատակարարի իրավաբանական հասցե։ |
supplierBusinessAddress |
String(100) |
Optional |
Մատակարարի գործունեության հասցե։ |
supplierSettlementAccount |
String(22) |
Optional |
Մատակարարի հաշվարկային հաշիվ։ |
supplierTaxCode |
String(20) |
Optional |
Մատակարարի ՀՎՀՀ։ |
supplierManagerPosition |
String(100) |
Optional |
Մատակարարի ղեկավարի պաշտոն։ |
supplierManagerName |
String(100) |
Optional |
Մատակարարի ղեկավարի Ա․Ա․Հ․։ |
supplierAccountantPosition |
String(100) |
Optional |
Մատակարարի հաշվապահի պաշտոն։ |
supplierAccountantName |
String(100) |
Optional |
Մատակարարի հաշվապահի անվանում։ |
supplierAdditionalData |
String(255) |
Optional |
Մատակարարի վերաբերյալ լրացուցիչ տվյալներ։ |
customerName |
String(50) |
Optional |
Գնորդի անվանում։ |
customerLegalAddress |
String(255) |
Optional |
Գնորդի իրավաբանական հասցե։ |
customerBusinessAddress |
String(255) |
Optional |
Գնորդի գործունեության հասցե։ |
customerSettlementAccount |
String(22) |
Optional |
Գնորդի հաշվարկային հաշիվ։ |
customerTaxCode |
String(20) |
Optional |
Գնորդի ՀՎՀՀ։ |
customerManagerPosition |
String(50) |
Optional |
Գնորդի ղեկավարի պաշտոն։ |
customerManagerName |
String(50) |
Optional |
Գնորդի ղեկավարի Ա․Ա․Հ․։ |
customerAccountantPosition |
String(50) |
Optional |
Գնորդի հաշվապահի պաշտոն։ |
customerAccountantName |
String(50) |
Optional |
Գնորդի հաշվապահի անվանում։ |
stateRegisterNumber |
String(50) |
Optional |
Պետական գրանցման վկայականի համար։ |
idDocumentType |
Enum |
Optional |
Անձը հաստատող փաստաթղթի տեսակ։ Ընդունում է հետևյալ արժեքները․ 1 - ՀՀ անձնագիր, 2 - Ծննդյան վկայական, 3 - Կացության քարտ, 4 - Կոնվենցիոն ճանապարհորդական փաստաթուղթ, 5 - Նույնականացման քարտ, 6 - Կենսաչափական անձնագիր, 7 - Օտարերկրյա անձնագիր՝ ՀՀ-ում աշխատանքի իրավունքով, 8 - Օտարերկրյա անձնագիր։ |
passportNumber |
String(32) |
Optional |
Անձնագրի համար։ |
customerAdditionalData |
String(255) |
Optional |
Գնորդի վերաբերյալ լրացուցիչ տվյալներ։ |
shippingMethod |
String(255) |
Optional |
Ապրանքների առաքման եղանակ։ |
additionalFullName |
String(255) |
Optional |
Լիազորված անձի Ա․Ա․Հ․։ |
credentialNumber |
String(255) |
Optional |
Լիազորագրի համար։ |
credentialDate |
Date(YYYY-MM-DD) |
Optional |
Լիազորագրի ամսաթիվ։ |
itemList [0..n] |
Array |
*Required |
Ապրանքների և ծառայությունների անվանացուցակ (մասսիվ): Անվանացուցակը պետք է պարունակի ապրանքի կամ ծառայութան առնվազն մեկ տող։ |
Հաշվարկվում է համակարգի բիզնես տրամաբանությամբ․ ձեր կողմից փոխանցված ցանկացած արժեք կփոփոխվի համակարգի կողմից։
Անվանացուցակի տողի դաշտերը (itemList)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
type |
Enum |
Optional |
Տողի տեսակ։ Ընդունում է հետևյալ արժեքները․ 1-Ապրանք, 2-Ծառայություն: |
storage |
String(5) |
*Required Reference type |
Պահեստի կոդ: |
id |
Integer |
System defined |
Ապրանքի կամ ծառայության ներքին նույնացուցիչ։ |
code |
String(20) |
*Required Reference type |
Ապրանքի կամ ծառայության կոդ: |
name |
String(200) |
Optional |
Ապրանքի կամ ծառայության անվանում: Ծառայության դեպքում անվանումը կարելի է վերագրել։ Ապրանքի դեպքումը դաշտի արժեքը կանտեսվի։ |
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 |
Optional |
Զեղչի գումար: Զեղչի տոկոսը ուղարկելու դեպքում զեղչի գումարը հաշվարկվում է ավտոմատ։ |
environmentalFeePercent |
Decimal |
Optional |
Բնապահպանական հարկի տոկոս: Այս դաշտն արտացոլվում է, եթե Դրույթներում նշված է Բնապահպանական հարկ վճարող դրոշակը: |
environmentalFeeAmount |
Decimal |
Optional |
Բնապահպանական հարկի գումար: Բնապահպանական հարկի %-ը ուղարկելու դեպքում անհրաժեշտ է ուղարկել նաև գումարը։ Գումարի ավտոմատ հաշվարկ չի կատարվում։ Այս դաշտն արտացոլվում է, եթե Դրույթներում նշված է Բնապահպանական հարկ վճարող դրոշակը: |
vat |
Boolean |
Optional |
ԱԱՀ-ով հարկման հայտանիշ: |
dealType |
Enum |
Optional |
Գործարքի տեսակ։ |
description |
String(50) |
Optional |
Ապրանքի նկարագրություն։ |
cpaClassifier |
String(12) |
Optional Reference type |
Ապրանքի (ծառայության) ԱՏԳԱԱ դասակարգիչ: |
rowNumber |
Integer |
System defined |
Տողի համար։ |
rowId |
Integer |
System defined |
Տողի ներքին նույնացուցիչ։ |
markingList[] |
Array |
Optional |
Դրոշմավորման ծածկագրերի ցուցակ (մասսիվ): |
Օրինակ 1. Վաճառք (Հաշիվ-Ապրանքագիր) փաստաթղթի ստեղծում (պարտադիր դաշտերով)
|
Օրինակ 2. Վաճառք (Հաշիվ-Ապրանքագիր) փաստաթղթի ստեղծում (լրացուցիչ դաշտերով)
POST |
|
Օրինակ 3. Նշված isn-ով Վաճառք (Հաշիվ-Ապրանքագիր) փաստաթղթի ստացում
|
Օրինակ 4. Նշված isn-ով Վաճառք (Հաշիվ-Ապրանքագիր) փաստաթղթի դաշտերի թարմացում
|
Օրինակ 5. Նշված isn-ով Վաճառք (Հաշիվ-Ապրանքագիր) փաստաթղթի հեռացում
|