Գործընկերների պայմանագրեր

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

Գործընկերների պայմանագրեր

 Previous pageReturn to chapter overviewNext page

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

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

URI

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

URL Swagger

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

GitHub

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

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

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

 

 

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

 

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

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

Անվանում

Տեսակ

Կիրառումը

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

partnerId

UUID

System defined

Գործընկերոջ նույնացուցիչ։

partnerCode

String(20)

*Required

Գործընկերոջ կոդ։

partnerName

String(50)

*Required

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

partnerTaxCode

String(20)

Optional

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

partnerPhone

String(50)

Optional

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

partnerGroup

String(5)

*Required

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

partnerGroupName

String(5)

*Required

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

costumer

Boolean

Optional

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

supplier

Boolean

Optional

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

contractCode

String(3)

Optional

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

contractName

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

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

 

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/contracts' \

 -H 'accept: text/plain' \

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

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

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

 -d '{

 "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,

 "partnerId": 0,

 "partnerCode": "1001",

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

 "contractCode": "002",

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

 "priceTypeName": ""

}'

 

Response body (201 Created)

 

{

 "partnerId": 100000,

 "partnerCode": "1001",

 "partnerName": "",

 "contractCode": "002",

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

 "priceTypeName": "",

 "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": false

}

 

 

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

GET

Request

 

curl -X 'GET' \

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

 -H 'accept: */*' \

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

 -H 'apiKey: 0B_T,KUCmWg45Pp[!AQl'

 

Response body  (200 OK)

 

{

 "partnerId": 100000,

 "partnerCode": "1001",

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

 "contractCode": "001",

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

 "priceTypeName": "Մեծածախ",

 "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

}

 

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

PUT

Request

 

curl -X 'PUT' \

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

 -H 'accept: text/plain' \

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

 -H 'apiKey: 0B_T,KUCmWg45Pp[!AQl' \

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

 -d '{

 "currency": "AMD",

 "priceType": "01",

 "date": "2026-02-14",

 "description": "",

 "discountPercent": 0,

 "cardCode": "",

 "bonusCard": true,

 "bonusPercent": 0,

 "bonusPoint": 0,

 "validationPeriodStart": "2026-02-14",

 "validationPeriodEnd": "2026-02-14",

 "canceled": true,

 "receivablesControl": true,

 "receivablesLimit": 0,

 "default": true,

 "partnerId": 0,

 "partnerCode": "1011",

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

 "contractCode": "",

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

 "priceTypeName": ""

}'

 

Response body  (200 OK)

 

{

 "partnerId": 100000,

 "partnerCode": "1001",

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

 "contractCode": "001",

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

 "priceTypeName": "Մեծածախ",

 "currency": "AMD",

 "priceType": "01",

 "date": "2026-02-14",

 "description": "",

 "discountPercent": 0,

 "cardCode": "",

 "bonusCard": true,

 "bonusPercent": 0,

 "bonusPoint": 0,

 "validationPeriodStart": "2026-02-14",

 "validationPeriodEnd": "2026-02-14",

 "canceled": true,

 "receivablesControl": true,

 "receivablesLimit": 0,

 "default": true

}        

 

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

DELETE

Request

 

curl -X 'DELETE' \

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

 -H 'accept: */*' \

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

 -H 'apiKey: 0B_T,KUCmWg45Pp[!AQl'

 

Response body  (200 OK)