API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) Փոխանցման հաշիվ փաստաթուղթը:
URI |
https://api.armsoft.am/trade/v1/documents/transferinvoice |
GitHub |
https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/documents/transferinvoice.md |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ 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) |
*Required |
Փաստաթղթի համար: Եթե համարը չի փոխանցվում, ապա գրանցվում է վերջին համարին ավելացնելով 1: |
state |
Enum |
Optional |
Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները. 0 - Գրանցված կամ սևագիր, 1 - Սևագիր, 2 - Գրանցված, 99 - Հեռացված: Եթե վիճակը չի փոխանցվում, փաստաթուղթը ավտոմատ գրանցված վիճակում է ուղարկվում։ |
customer |
String(20) |
Optional Reference type |
Գնորդի կոդ: |
currency |
String(3) |
*Required Reference type |
Փաստաթղթի արժույթի կոդ: Եթե արժեք չենք տալիս, ավտոմատ լրացվում է ծրագրի դրույթներում նշված արժեքը։ |
exchangeRate |
Decimal |
*Conditional required |
Արժույթի փոխարժեք: |
exchangeBase |
Decimal |
*Conditional required |
Արժույթի փոխարժեքի պատիկություն: |
contract |
String(3) |
Optional Reference type |
Գնորդի պայմանագրի կոդ։ Արժեք չուղարկելու դեպքում ավտոմատ լրացվում է գնորդի հիմնական պայմանագրի կոդը։ |
contractDate |
Date(YYYY-MM-DD) |
Optional |
Պայմանագրի ամսաթիվ։ |
comment |
String(255) |
Optional |
Փաստաթղթի մեկնաբանություն։ |
owner |
String(50) |
Optional Reference type |
Փաստաթուղթը ստեղծող օգտագործողը։ |
vatCalculationType |
Enum |
Optional |
ԱԱՀ-ի հաշվարկի ձև։ Ընդունում է հետևյալ արժեքները. 1 - ԱԱՀ-ով, 2 - ԱԱՀ-ն այդ թվում, 3 - Առանց ԱԱՀ, 4 - Զրոյական ԱԱՀ, 5 - ԱԱՀ-ն այդ թվում 16.67 % Եթե արժեք չենք տալիս, ավտոմատ լրացվում է ծրագրի դրույթներում նշված արժեքը։ |
priceType |
String(2) |
Optional Reference type |
Նշվում է, թե ինչ գներով են վաճառվում ապրանքները։ |
storage |
String(5) |
Optional Reference type |
Պահեստի կոդ։ |
discountPercent |
Decimal |
Optional |
Զեղչի տոկոս։ |
vatAmount |
Decimal |
*Required |
ԱԱՀ-ի գումար: ԱԱՀ-ի գումարը ավտոմատ հաշվարկվում է ապրանքի վրա նշված ԱԱՀ-ի հաշվարկման բնութագրիչի, ԱԱՀ-ի հաշվարկի ձևի և ընդհանուր գումարի հիման վրա։ |
totalAmount |
Decimal |
*Required |
Ընդհանուր գումար: Ընդհանուր գումարը ավտոմատ է հաշվարկվում տրված գնի և քանակի հիման վրա։ |
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 |
Մատակարարի հաշվապահի անվանում։ |
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 |
Պետական գրանցման վկայականի համար։ |
passportNumber |
String(32) |
Optional |
Անձնագրի համար։ |
itemList [0..n] |
Array |
*Required |
Ապրանքների և ծառայությունների անվանացուցակ (մասսիվ): Անվանացուցակը պետք է պարունակի ապրանքի կամ ծառայութան առնվազն մեկ տող։ |
Հաշվարկվում է համակարգի բիզնես տրամաբանությամբ․ ձեր կողմից փոխանցված ցանկացած արժեք կփոփոխվի համակարգի կողմից։
Անվանացուցակի տողի դաշտերը (itemList)
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
type |
Enum |
Optional |
Տողի տեսակ։ Ընդունում է հետևյալ արժեքները․ 1-Ապրանք, 2-Ծառայություն: |
storage |
String(5) |
Optional 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 |
Ապրանքի քանակը կամ ծառայության ծավալ: |
price |
Decimal |
*Required |
Վաճառքի գին: |
discountPercent |
Decimal |
Optional |
Զեղչի տոկոս: Զեղչված գինը ուղարկելու դեպքում զեղչի տոկոսը հաշվարկվում է ավտոմատ։ |
discountedPrice |
Decimal |
Optional |
Զեղչված գին: Զեղչի տոկոսը ուղարկելու դեպքում զեղչված գինը հաշվարկվում է ավտոմատ։ |
amount |
Decimal |
Optional |
Զեղչված գումար: Զեղչի տոկոսը ուղարկելու դեպքում զեղչված գումարը հաշվարկվում է ավտոմատ։ |
vat |
Boolean |
Optional |
ԱԱՀ-ով հարկման հայտանիշ: |
rowNumber |
Integer |
System defined |
Տողի համար։ |
rowId |
Integer |
System defined |
Տողի ներքին նույնացուցիչ։ |
Օրինակ 1. Փոխանցման հաշիվ փաստաթղթի ստեղծում (պարտադիր դաշտերով)
|
Օրինակ 2. Փոխանցման հաշիվ փաստաթղթի ստեղծում (լրացուցիչ դաշտերով)
POST |
|
Օրինակ 3. Նշված isn-ով Փոխանցման հաշիվ փաստաթղթի ստացում
|
Օրինակ 4. Նշված isn-ով Փոխանցման հաշիվ փաստաթղթի դաշտերի խմբագրում
|
Օրինակ 5. Նշված isn-ով Փոխանցման հաշիվ փաստաթղթի հեռացում
|