API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) գործընկերների տեղեկատուն:
URI |
https://api.armsoft.am/trade/v1/directories/partners |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Ապրանքների չափման միավորների օբյեկտի դաշտերը
Ստորև ներկայացված է օբյեկտի դաշտերի նկարագրությունը.
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
id |
Integer |
Գործընկերոջ ներքին նույնացուցիչ։Դրամարկղի կոդ։ |
|
code |
String(20) |
Գործընկերոջ կոդը։Նոր ավելացվող գործընկերոջ համար, որպես հերթական կոդ, համակարգն ավտոմատ առաջարկում է հաջորդը, որը հաշվարկվում է վերջին ավելացված գործընկերոջ կոդից։ Այս դաշտը խմբագրման ենթակա չէ։Պարտադիր լրացվող դաշտ է։ |
|
name |
String(50) |
Գործընկերոջ անվանումը։Պարտադիր լրացվող դաշտ է։ |
|
fullName |
String(255) |
Գործընկերոջ լրիվ անվանումը։ |
|
taxCode |
String(20) |
Գործընկերոջ հարկ վճարողի հաշվառման համարը։ |
|
group |
String(5) |
Գործընկերոջ խմբի անվանումը։ |
|
supplier |
Boolean |
Հայտանիշ, արդյոք գործընկերը Մատակարար է, թե ոչ: |
|
costumer |
Boolean |
Հայտանիշ, արդյոք գործընկերը Գնորդ է, թե ոչ: |
|
legalAddress |
String(255) |
Գործընկերոջ իրավաբանական հասցեն։ |
|
businessAddress |
String(255) |
Գործընկերոջ գործունեության իրականացման վայրի հասցեն։ |
|
managerName |
String(50) |
Գործընկերոջ ղեկավարի ազգանուն, անուն, հայրանունը։ |
|
managerPosition |
String(50) |
Գործընկերոջ ղեկավարի պաշտոնը։ |
|
accountantName |
String(50) |
Գործընկերոջ հաշվապահի ազգանուն, անուն, հայրանունը։ |
|
accountantPosition |
String(50) |
Գործընկերոջ հաշվապահի պաշտոնը։ |
|
paymentMainAim |
String(50) |
|
|
phoneNumber |
String(50) |
Գործընկերոջ հեռախոսը։ |
|
String(129) |
Գործընկերոջ էլեկտրոնային փոստի հասցեն։ |
||
stateRegisterNumber |
String(50) |
Եթե տվյալ գործընկերը անհատ ձեռնարկատեր է, ապա այստեղ լրացվում է նրա պետական գրանցման վկայականի համարը։ |
|
passportNumber |
String(32) |
Գործընկերոջ անձնագևային համարը։ |
|
gender |
Enum |
Գործընկերոջ սեռը։ Ընդունում է հետևյալ արժեքները․ 1-Արական 2-Իգական |
|
birthDate |
Date(YYYY-MM-DD) |
Լրացվում է գործընկերոջ ծննդյան ամսաթիվը։ |
|
idDocumentType |
Enum |
|
|
status |
String |
Մեկնաբանություն։ |
|
groupName |
String(50) |
Գործընկերոջ խմբի անվանումը։ |
|
settlementAccount |
Array |
Հաշվարկային հաշիվներ (մասսիվ): |
|
userName |
String(50) |
Օգտագործողի անվանումը։ |
|
creationDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Ստեղծման օրը։ |
|
lastChange |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Վերջին կատարված փոփոխություն։ |
|
POST |
|
POST |
|
POST |
|
|
GET |
|
|
PUT |
|
|
DELETE |
|