Գործընկերներ

Ուղղորդիչ:  REST API (ամպային տարբերակ) > Տեղեկատուներ > Գործընկերներ >

Գործընկերներ

 Previous pageReturn to chapter overviewNext page

Բացել/Փակել թաքցված տեքստը

API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) գործընկերների տեղեկատուն:

URI

https://api.armsoft.am/trade/v1/directories/partners

URL Swagger

https://api.armsoft.am/trade/swagger/index.html#/Partners

GitHub

https://github.com/armsoft/trade-public-api-docs/tree/main/docs/api/directories/partners

Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:

-H 'apiKey: hJk:|^&99։՛(=0#biWc:'

 

Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:

 

Գործընկերների օբյեկտի դաշտերը

Գործընկերներ տեղեկատուի ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

id

UUID

System defined

Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։

code

String(20)

*Required

Գործընկերոջ կոդը։Նոր ավելացվող գործընկերոջ համար, որպես հերթական կոդ, համակարգն ավտոմատ առաջարկում է հաջորդը, որը   հաշվարկվում է վերջին ավելացված գործընկերոջ կոդից։ Այս դաշտը խմբագրման ենթակա չէ։Պարտադիր լրացվող դաշտ է։

name

String(50)

*Required

Գործընկերոջ անվանումը։Պարտադիր լրացվող դաշտ է։  

fullName

String(255)

Optional

Գործընկերոջ լրիվ անվանումը։

taxCode

String(20)

Optional

Գործընկերոջ հարկ վճարողի հաշվառման համարը։

group

String(5)

Optional

Reference type

Գործընկերոջ խումբը։

supplier

Boolean

Optional

Հայտանիշ, արդյոք գործընկերը Մատակարար է, թե ոչ:

costumer

Boolean

Optional

Հայտանիշ, արդյոք գործընկերը Գնորդ է, թե ոչ:

legalAddress

String(255)

Optional

Գործընկերոջ իրավաբանական հասցեն։

businessAddress

String(255)

Optional

Գործընկերոջ գործունեության իրականացման վայրի հասցեն։

managerName

String(50)

Optional

Գործընկերոջ ղեկավարի ազգանուն, անուն, հայրանունը։

managerPosition

String(50)

Optional

Գործընկերոջ ղեկավարի պաշտոնը։

accountantName

String(50)

Optional

Գործընկերոջ հաշվապահի ազգանուն, անուն, հայրանունը։

accountantPosition

String(50)

Optional

Գործընկերոջ հաշվապահի պաշտոնը։

paymentMainAim

String(50)

Optional

Վճարման հիմնական նպատակ։

phoneNumber

String(50)

Optional

Գործընկերոջ հեռախոսահամար։

email

String(129)

Optional

Գործընկերոջ էլեկտրոնային փոստի հասցեն։

stateRegisterNumber

String(50)

Optional

Եթե տվյալ գործընկերը անհատ ձեռնարկատեր է, ապա այստեղ լրացվում է նրա պետական գրանցման վկայականի համարը։

passportNumber

String(32)

Optional

Գործընկերոջ անձնագևային համարը։

gender

Enum

Optional

Գործընկերոջ սեռը։ Ընդունում է հետևյալ արժեքները․

1-Արական

2-Իգական

birthDate

Date(YYYY-MM-DD)

Optional

Լրացվում է գործընկերոջ ծննդյան ամսաթիվը։

idDocumentType

Enum

Optional

Գործընկերոջ անձը հաստատող փաստաթղթի տեսակ:

status

String

Optional

Մեկնաբանություն։

defaultContractCode

String

Optional

Հիմնական պայմանագրի կոդ։

contracts[]

Array

Optional

Պայմանագրեր։

settlementAccounts[]

Array

Optional

Հաշվարկային հաշիվներ։

additionalAddresses[]

Array

Optional

Լրացուցիչ հասցեներ։

 

Պայմանագրի տողերի դաշտերը(PartnerContractRow)

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

Code

String(3)

Optional

Պայմանագրի կոդ։

Name

String(45)

Optional

Պայմանագրի անվանումը։

currency

String(3)

Optional

Արժույթ։

priceType

Array

Optional

Գնի տեսակի կոդ:

date

DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ)

Optional

Պայմանագրի կնքման ամսաթիվ:

description

String(45)

Optional

Պայմանագրի նկարագրություն:

discountPercent

Decimal

Optional

Զեղչի տոկոս։

cardCode

String(45)

Optional

Քարտի կոդ:

bonusCard

Boolean

Optional

Բոնուսային պայմանագիր է, թե ոչ։

bonusPercen

Decimal

Optional

Բոնուսային քարտի %:

bonusPoint

Decimal

Optional

Բոնուսային քարտի միավոր:

validationPeriodStart

DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ)

Optional

Վավերականության ժամկետի սկիզբ։

validationPeriodEnd

DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ)

Optional

Վավերականության ժամկետի ավարտ։

canceled

Boolean

Optional

Պայմանագիրը կասեցված է, թե ոչ։

receivablesControl

Boolean

Optional

Պայմանագրով պարտքի մնացորդը վերահսկվում է, թե ոչ:

receivablesLimit

Decimal

Optional

Պայմանագրով պարտքի մնացորդի սահմանաչափ:

default

Boolean

Optional

Հիմնական պայմնագիրն է, թե ոչ։

 

Հաշվարկային հաշիվների տողերի դաշտերը(PartnerSettlementAccountRow)

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

   account

String(20)

Optional

Գործընկերոջ հաշվարկային հաշիվ:

   name

String(38)

Optional

Անվանում:

default

Boolean

Optional

Հիմնական Հաշվարկային հաշիվ է, թե ոչ։

 

Լրացուցիչ հասցեների տողերի դաշտերը(PartnerBusinessAddresRow)

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

   name

String(38)

Optional

Գործընկերոջ գործունեության լրացուցիչ հասցե:

   default

Boolean

Optional

Հիմնական հասցե է, թե ոչ։

 

GitHub

https://github.com/armsoft/trade-public-api-docs/tree/main/examples/csharp/directories/partners

Օրինակ 1. Գործընկերներ տեղեկատուում նոր գործընկերոջ ավելացում

POST

Request

 

 curl -X 'POST' \

 'https://api.armsoft.am/trade/v1/directories/partners' \

 -H 'accept: text/plain' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: If;]_v&aEh06.L$h.ipU' \

 -H 'Content-Type: application/json' \

 -d '{

 "id": 0,

 "code": "1011",

 "name": "anun",

 "fullName": "azganun",

 "taxCode": "000807555",

 "group": "01",

 "supplier": true,

 "customer": true,

 "legalAddress": "ք. Երևան, Պուշկին",

 "businessAddress": "ք. Երևան, Պուշկին",

 "managerName": "Ս. Աբրահամյան",

 "managerPosition": "Տնօրեն",

 "accountantName": "string",

 "accountantPosition": "Կ.Մալխասյան",

 "paymentMainAim": "string",

 "phoneNumber": "string",

 "email": "string",

 "stateRegisterNumber": "string",

 "passportNumber": "060690000",

 "gender": "1",

 "birthDate": "2026-02-13",

 "idDocumentType": "1",

 "status": "string",

 "defaultContractCode": "string",

 "contracts": [

   {

     "currency": "AMD",

     "priceType": "01",

     "date": "2026-02-13",

     "description": "",

     "discountPercent": 0,

     "cardCode": "",

     "bonusCard": true,

     "bonusPercent": 0,

     "bonusPoint": 0,

     "validationPeriodStart": "2026-02-13",

     "validationPeriodEnd": "2026-02-13",

     "canceled": true,

     "receivablesControl": true,

     "receivablesLimit": 0,

     "default": true,

     "code": "001",

     "name": "Հիմնական պայմանագիր"

   }

 ],

 "settlementAccounts": [

   {

     "account": "string",

     "name": "string",

     "default": true

   }

 ],

 "additionalAddresses": [

   {

     "name": "string",

     "default": true

   }

 ]

}

 

Response body (201 Created)

 

{

 "defaultContractCode": "001",

 "contracts": [

   {

     "code": "001",

     "name": "Հիմնական պայմանագիր",

     "currency": "AMD",

     "priceType": "01",

     "date": "2026-02-13",

     "description": "",

     "discountPercent": 0,

     "cardCode": "",

     "bonusCard": true,

     "bonusPercent": 0,

     "bonusPoint": 0,

     "validationPeriodStart": "2026-02-13",

     "validationPeriodEnd": "2026-02-13",

     "canceled": true,

     "receivablesControl": true,

     "receivablesLimit": 0,

     "default": true

   }

 ],

 "settlementAccounts": [

   {

     "account": "string",

     "name": "string",

     "default": true

   }

 ],

 "additionalAddresses": [

   {

     "name": "ք. Երևան, Պուշկին",

     "default": true

   }

 ],

 "id": 100021,

 "code": "1011",

 "name": "anun",

 "fullName": "azganun",

 "taxCode": "000807555",

 "group": "01",

 "supplier": true,

 "customer": true,

 "legalAddress": "ք. Երևան, Պուշկին",

 "businessAddress": "ք. Երևան, Պուշկին",

 "managerName": "Ս. Աբրահամյան",

 "managerPosition": "Տնօրեն",

 "accountantName": "string",

 "accountantPosition": "Կ.Մալխասյան",

 "paymentMainAim": "string",

 "phoneNumber": "string",

 "email": "string",

 "stateRegisterNumber": "string",

 "passportNumber": "060690000",

 "gender": " ",

 "birthDate": "2026-02-13",

 "idDocumentType": "1",

 "status": ""

}

 

Օրինակ 2. Նշված կոդով գործընկերոջ տեղեկատուի տվյալների ստացում

GET

v1/directories/partners/{code}                                                                    

Request

 

curl -X 'GET' \

 'https://api.armsoft.am/trade/v1/directories/partners/1001' \

 -H 'accept: */*' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: If;]_v&aEh06.L$h.ipU'

 

Response body  (200 OK)

 

{

 "defaultContractCode": "001",

 "contracts": [

   {

     "code": "001",

     "name": "Հիմնական պայմանագիր",

     "currency": "AMD",

     "priceType": "",

     "description": "",

     "discountPercent": 0,

     "cardCode": "",

     "bonusCard": false,

     "bonusPercent": 0,

     "bonusPoint": 0,

     "canceled": false,

     "receivablesControl": false,

     "receivablesLimit": 0,

     "default": true

   }

 ],

 "settlementAccounts": [

   {

     "account": "1930000000000001",

     "name": "ՙԿոնվերսբանկ՚ՓԲԸ",

     "default": true

   }

 ],

 "additionalAddresses": [

   {

     "name": "ք. Երևան, Պուշկինի 10",

     "default": true

   }

 ],

 "id": 100000,

 "code": "1001",

 "name": "Գալատեա ՍՊԸ",

 "fullName": "Գալատեա ՍՊԸ",

 "taxCode": "12225658",

 "group": "011",

 "supplier": true,

 "customer": false,

 "legalAddress": "ք. Երևան, Պուշկինի 10",

 "businessAddress": "ք. Երևան, Պուշկինի 10",

 "managerName": "Ս. Աբրահամյան",

 "managerPosition": "Տնօրեն",

 "accountantName": "Կ.Մալխասյան",

 "accountantPosition": "Գլխավոր հաշվապահ",

 "paymentMainAim": "Համաձայն 001 պայմանագրի",

 "phoneNumber": "",

 "email": "",

 "stateRegisterNumber": "",

 "passportNumber": "",

 "gender": " ",

 "idDocumentType": " ",

 "status": ""

}

 

Օրինակ 3. Նշված կոդով գործընկերոջ տեղեկատուի տվյալների խմբագրում

PUT

Request

 

curl -X 'PUT' \

 'https://api.armsoft.am/trade/v1/directories/partners/1001' \

 -H 'accept: text/plain' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: If;]_v&aEh06.L$h.ipU' \

 -H 'Content-Type: application/json' \

 -d '{

 "id": 0,

 "code": "1001",

 "name": "Գալատեա ՍՊԸ նոր",

 "fullName": "Գալատեա ՍՊԸ",

 "taxCode": "12225658",

 "group": "011",

 "supplier": true,

 "customer": true,

 "legalAddress": "ք. Երևան, Պուշկինի 10",

 "businessAddress": "ք. Երևան, Պուշկինի 10",

 "managerName": "string",

 "managerPosition": "Ս. Աբրահամյան",

 "accountantName": "Կ.Մալխասյան",

 "accountantPosition": "Գլխավոր հաշվապահ",

 "paymentMainAim": "Համաձայն 001 պայմանագրի",

 "phoneNumber": "string",

 "email": "string",

 "stateRegisterNumber": "string",

 "passportNumber": "060690000",

 "gender": "",

 "birthDate": "2026-02-13",

 "idDocumentType": "",

 "status": "",

 "defaultContractCode": "",

 "contracts": [

   {

     "currency": "AMD",

     "priceType": "01",

     "date": "2026-02-13",

     "description": "",

     "discountPercent": 0,

     "cardCode": "",

     "bonusCard": true,

     "bonusPercent": 0,

     "bonusPoint": 0,

     "validationPeriodStart": "2026-02-13",

     "validationPeriodEnd": "2026-02-13",

     "canceled": true,

     "receivablesControl": true,

     "receivablesLimit": 0,

     "default": true,

     "code": "001",

     "name": "Հիմնական պայմանագիր"

   }

 ],

 "settlementAccounts": [

   {

     "account": "string",

     "name": "string",

     "default": true

   }

 ],

 "additionalAddresses": [

   {

     "name": "string",

     "default": true

   }

 ]

}'

 

Response body  (200 OK)

 

{

 "defaultContractCode": "001",

 "contracts": [

   {

     "code": "001",

     "name": "Հիմնական պայմանագիր",

     "currency": "AMD",

     "priceType": "01",

     "date": "2026-02-13",

     "description": "",

     "discountPercent": 0,

     "cardCode": "",

     "bonusCard": true,

     "bonusPercent": 0,

     "bonusPoint": 0,

     "validationPeriodStart": "2026-02-13",

     "validationPeriodEnd": "2026-02-13",

     "canceled": true,

     "receivablesControl": true,

     "receivablesLimit": 0,

     "default": true

   }

 ],

 "settlementAccounts": [

   {

     "account": "string",

     "name": "string",

     "default": true

   }

 ],

 "additionalAddresses": [

   {

     "name": "ք. Երևան, Պուշկինի 10",

     "default": true

   }

 ],

 "id": 100000,

 "code": "1001",

 "name": "Գալատեա ՍՊԸ նոր",

 "fullName": "Գալատեա ՍՊԸ",

 "taxCode": "12225658",

 "group": "011",

 "supplier": true,

 "customer": true,

 "legalAddress": "ք. Երևան, Պուշկինի 10",

 "businessAddress": "ք. Երևան, Պուշկինի 10",

 "managerName": "string",

 "managerPosition": "Ս. Աբրահամյան",

 "accountantName": "Կ.Մալխասյան",

 "accountantPosition": "Գլխավոր հաշվապահ",

 "paymentMainAim": "Համաձայն 001 պայմանագրի",

 "phoneNumber": "string",

 "email": "string",

 "stateRegisterNumber": "string",

 "passportNumber": "060690000",

 "gender": " ",

 "birthDate": "2026-02-13",

 "idDocumentType": " ",

 "status": ""

}

 

Օրինակ 4. Նշված կոդով գործընկերոջ տեղեկատուի հեռացում

DELETE

Request

 

curl -X 'DELETE' \

 'https://api.armsoft.am/trade/v1/directories/partners/1001' \

 -H 'accept: */*' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: If;]_v&aEh06.L$h.ipU'

 

Response body  (200 OK)