REST API (ամպային տարբերակ) > Տեղեկատուներ

API-ի միջոցով հնարավոր է ստանալ (POST) Գործընկերների ցուցակը։

URI	https://api.armsoft.am/accountant/v1/directories/partners/list

URL Swagger

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

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

@SKq7*ERI]ZIgXvpkWhV

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

Հարցման պարամետրեր (Request Body)

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

Անվանում	Տեսակ	Կիրառումը	Նկարագրություն
pageSize	Integer	Optional	Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վերադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։ Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։
codes	Array	Optional Reference type	Գործընկերների կոդերը։
lastModifiedDate	Enum	Optional	Վերջին խմբագրման ամսաթիվը։

Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)

Անվանում	Տեսակ	Նկարագրություն
id	Integer	Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։
hasMore	Boolean	Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։
data[]	Array	Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։

Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)

Անվանում	Տեսակ	Նկարագրություն
id	Integer	Գործընկերոջ ներքին նույնացուցիչ։Դրամարկղի կոդ։
code	String	Գործընկերոջ կոդը։Նոր ավելացվող գործընկերոջ համար, որպես հերթական կոդ, համակարգն ավտոմատ առաջարկում է հաջորդը, որը հաշվարկվում է վերջին ավելացված գործընկերոջ կոդից։ Այս դաշտը խմբագրման ենթակա չէ։Պարտադիր լրացվող դաշտ է։
name	String	Գործընկերոջ անվանումը։Պարտադիր լրացվող դաշտ է։
fullName	String	Գործընկերոջ լրիվ անվանումը։
taxCode	String	Գործընկերոջ հարկ վճարողի հաշվառման համարը։
group	String	Գործընկերոջ խմբի կոդը։
groupName	String	Գործընկերոջ խմբի անվանումը։
vatPayer	String	Հանդիսանում է գործընկերը ԱԱՀ վճարող` 0 / False - ԱԱՀ վճարող չէ, 1 / True - ԱԱՀ վճարող է:
legalAddress	String	Գործընկերոջ իրավաբանական հասցեն։
businessAddress	String	Գործընկերոջ գործունեության իրականացման վայրի հասցեն։
managerName	String	Գործընկերոջ ղեկավարի ազգանուն, անուն, հայրանունը։
managerPosition	String	Գործընկերոջ ղեկավարի պաշտոնը։
accountantName	String	Գործընկերոջ հաշվապահի ազգանուն, անուն, հայրանունը։
accountantPosition	String	Գործընկերոջ հաշվապահի պաշտոնը։
stateRegisterNumber	String	Եթե տվյալ գործընկերը անհատ ձեռնարկատեր է, ապա այստեղ լրացվում է նրա պետական գրանցման վկայականի համարը։
idDocumentType	Enum	Գործընկերոջ անձը հաստատող փաստաթղթի տեսակ:
passportNumber	String	Գործընկերոջ անձնագևային համարը։
socialCardNumber	String	Հանրային ծառայությունների համարանիշ։
paymentMainAim	String	Վճարման հիմնական նպատակ։
phoneNumber	String	Գործընկերոջ հեռախոսը։
email	String	Գործընկերոջ էլեկտրոնային փոստի հասցեն։
contract	String	Պայմանագրիր:
salesDiscountPercent	String	Լրացվում է վաճառքի զեղչի տոկոսը:
settlementAccount	Array	Հաշվարկային հաշիվներ (մասսիվ):
userId	Integer	Օգտագործողի ներքին նույնացուցիչ:
userName	String	Օգտագործողի անվանումը։
lastChange	DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ)	Վերջին կատարված փոփոխություն։

Օրինակ 1. Գործընկերների ցուցակի ստացում

POST