URI

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

URL Swagger

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

GitHub

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

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

Անվանում

Տեսակ

Կիրառումը

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

  pageSize

Integer

Optional

Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վեչադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։

Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

  group

String(5)

Optional

Reference type

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

  codes

Array

Optional

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

  extended

Boolean

Optional

Տեղեկատուն ընլայնված սյուներով կանչելու հայտանիշ։

  lastModifiedDate

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

Optional

Վերջին խմբագրման ամսաթիվ։

  showAlsoClosed

Boolean

Optional

True արժեքի դեպքում ցուցակում կընդգրկվեն նաև փակված հայտանիշ ունեցող գործընկերները:

Անվանում

Տեսակ

Կիրառումը

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

id

UUID

System defined

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

hasMore

Boolean

Optional

Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

data[]

Array

Optional

Տվյալների ցուցակ (մասսիվ),  որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։

Անվանում

Տեսակ

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

id

Integer

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

code

String(20)

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

name

String(50)

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

fullName

String(255)

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

taxCode

String(20)

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

group

String(5)

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

groupName

String(50)

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

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)

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

email

String(129)

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

stateRegisterNumber

String(50)

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

passportNumber

String(32)

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

gender

Enum

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

1-Արական

2-Իգական

birthDate

Date(YYYY-MM-DD)

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

idDocumentType

Enum

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

status

String

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

settlementAccount

Array

Հաշվարկային հաշիվներ (մասսիվ):

userName

String(50)

Օգտագործողի անվանումը։

creationDate

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

Ստեղծման օրը։

lastChange

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

Վերջին կատարված փոփոխություն։

isClosed

Boolean

True արժեքի դեպքում տվյալ գործընկերը ընտրման ցուցակներում չի առաջարկվի:

GitHub

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

POST