API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) գործընկերների տեղեկատուն:
URI |
https://api.armsoft.am/accountant/v1/directories/partners |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
@SKq7*ERI]ZIgXvpkWhV |
Գործընկերների օբյեկտի դաշտերը
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
id |
Integer |
System defined |
Գործընկերոջ ներքին նույնացուցիչ։ Դրամարկղի կոդ։ |
code |
String(20) |
*Required |
Գործընկերոջ կոդը։ Նոր ավելացվող գործընկերոջ համար, որպես հերթական կոդ, համակարգն ավտոմատ առաջարկում է հաջորդը, որը հաշվարկվում է վերջին ավելացված գործընկերոջ կոդից։ Այս դաշտը խմբագրման ենթակա չէ։Պարտադիր լրացվող դաշտ է։ |
name |
String(50) |
*Required |
Գործընկերոջ անվանումը։Պարտադիր լրացվող դաշտ է։ |
fullName |
String(255) |
Optional |
Գործընկերոջ լրիվ անվանումը։ |
taxCode |
String(20) |
*Required |
Գործընկերոջ հարկ վճարողի հաշվառման համարը։ |
group |
String(5) |
*Required Reference type |
Գործընկերոջ խմբի անվանումը։ |
vatPayer |
Boolean |
Optional |
Հանդիսանում է գործընկերը ԱԱՀ վճարող` 0 / False - ԱԱՀ վճարող չէ, 1 / True - ԱԱՀ վճարող է: |
legalAddress |
String(255) |
Optional |
Գործընկերոջ իրավաբանական հասցեն։ |
businessAddress |
String(255) |
Optional |
Գործընկերոջ գործունեության իրականացման վայրի հասցեն։ |
managerName |
String(50) |
Optional |
Գործընկերոջ ղեկավարի ազգանուն, անուն, հայրանունը։ |
managerPosition |
String(50) |
Optional |
Գործընկերոջ ղեկավարի պաշտոնը։ |
accountantName |
String(50) |
Optional |
Գործընկերոջ հաշվապահի ազգանուն, անուն, հայրանունը։ |
accountantPosition |
String(50) |
Optional |
Գործընկերոջ հաշվապահի պաշտոնը։ |
stateRegisterNumber |
String(50) |
Optional |
Եթե տվյալ գործընկերը անհատ ձեռնարկատեր է, ապա այստեղ լրացվում է նրա պետական գրանցման վկայականի համարը։ |
idDocumentType |
Enum |
Optional |
Անձը հաստատող փաստաթղթի տեսակ։ Ընդունում է հետևյալ արժեքները․ 1 - ՀՀ անձնագիր, 2 - Ծննդյան վկայական, 3 - Կացության քարտ, 4 - Կոնվենցիոն ճանապարհորդական փաստաթուղթ, 5 - Նույնականացման քարտ, 6 - Կենսաչափական անձնագիր, 7 - Օտարերկրյա անձնագիր՝ ՀՀ-ում աշխատանքի իրավունքով, 8 - Օտարերկրյա անձնագիր։ |
passportNumber |
String(32) |
Optional |
Գործընկերոջ անձնագրի համարը։ |
socialCardNumber |
String |
Optional |
Հանրային ծառայությունների համարանիշ։ |
paymentMainAim |
String(50) |
Optional |
Վճարման հիմնական նպատակ։ |
phoneNumber |
String(50) |
Optional |
Գործընկերոջ հեռախոսը։ |
String(129) |
Optional |
Գործընկերոջ էլեկտրոնային փոստի հասցեն։ |
|
contract |
String |
Optional |
Պայմանագրիր: |
contractDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Պայմանագրի ամսաթիվը: |
salesDiscountPercent |
Decimal |
Optional |
Լրացվում է վաճառքի զեղչի տոկոսը: |
status |
String |
Optional |
Գործընկերոջ կարգավիճակ։ |
additionalData |
String(255) |
Optional |
Լրացուցիչ տվյալներ։ |
shippingMethod |
String(255) |
Optional |
Ապրանքների առաքման եղանակ։ |
additionalFullName |
String(255) |
Optional |
Լիազորված անձի Ա․Ա․Հ․։ |
credentialNumber |
String(255) |
Optional |
Լիազորագրի համար։ |
credentialDate |
Date(YYYY-MM-DD) |
Optional |
Լիազորագրի ամսաթիվ։ |
settlementAccounts[] |
Array |
Optional |
Հաշվարկային հաշիվներ (մասսիվ): |
additionalAddresses[] |
Array |
Optional |
Լրացուցիչ հասցեներ (մասսիվ)։ |
Հաշվարկային հաշիվների տողերի դաշտերը
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
account |
String(20) |
Optional |
Գործընկերոջ հաշվարկային հաշիվ: |
name |
String(255) |
Optional |
Հաշվի անվանում։ |
default |
Boolean |
Optional |
Հիմնական հաշիվ հանդիսանալու հայտանիշ։ |
Լրացուցիչ հասցեների տողերի դաշտերը
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
name |
String(255) |
Optional |
Գործընկերոջ գործունեության լրացուցիչ հասցե: |
default |
Boolean |
Optional |
Հիմնական հասցե հանդիսանալու հայտանիշ։ |
Օրինակ 1. Գործընկերներ տեղեկատուում նոր գործընկերոջ ավելացում
|
Օրինակ 2. Նշված կոդով գործընկերոջ տեղեկատուի տվյալների ստացում
|
Օրինակ 3. Նշված կոդով գործընկերոջ տեղեկատուի տվյալների խմբագրում
|
Օրինակ 4. Նշված կոդով գործընկերոջ տեղեկատուի տվյալների հեռացում
|