Վերադարձ (Կտրոն)

Ուղղորդիչ:  REST API (ամպային տարբերակ) > Փաստաթղթեր >

Վերադարձ (Կտրոն)

Previous pageReturn to chapter overviewNext page

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

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

URI

https://api.armsoft.am/trade/v1/documents/sale

URL Swagger

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

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

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

 

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

Ստորև ներկայացված է օբյեկտի ատրիբուտների նկարագրությունը.

Անվանում

Տեսակ

Կիրառումը

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

isn

UUID

api_optional api_required_upd api_system defined

Փաստաթղթի նույնացուցիչ: Պարտադիր է GET, PUT, DELETE հարցումների դեպքում։

Եթե POST հարցման ժամանակ UUID-ը չի փոխանցվում, սերվերը այն ավտոմատ գեներացնում է և վերադարձնում պատասխանում։

date

Date(YYYY-MM-DD)

api_optional

Փաստաթղթի ամսաթիվ: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը:

documentNumber

String(12)

api_optional

Փաստաթղթի համար: Եթե համարը չի փոխանցվում, ապա գրանցվում է վերջին համարին ավելացնելով 1:

state

Integer

api_optional

Փաստաթղթի վիճակի բնութագիր: Գրանցված, սևագիր, հեռացված։

storage

String(5)

api_required

api_reference type

Պահեստի կոդ:

cashDesk

String(8)

api_required

api_reference type

Դրամարկղի կոդ:

cashierShiftNumber

String(12)

api_optional

Հերթափոխի կոդ: Գրանցվում է նշված դրամարկղի բաց հերթափոխի կոդը: Եթե բաց հերթափոխ չի հայտնաբերվում, վերագրվում է դատարկ արժեք:

ecrCheckNumber

String(8)

api_optional

ՀԴՄ կտրոնի համար:

prepaymentECRCheckNumber

String(8)

api_optional

Կանխավճարի ՀԴՄ կտրոնի համար։

customer

String(20)

api_optional

api_reference type

Գնորդի կոդ:

customerContract

String(3)

api_conditionally required

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

seller

String(12)

api_optional

api_reference type

Վաճառողի կոդ:

printExpenseConfirmingCheck

Boolean

api_optional

Տպել ծախս հիմնավորող ՀԴՄ կտորոնը։

cashAmount

Decimal

api_conditionally required

cashAmount, nonCashAmount, bonusAmount, creditAmount և prepaymentAmount դաշտերի հանրագումարը պետք է հավասար լինի վաճառքի հանրագումարին (անվանացուցակի (itemsList) բոլոր տողերի amount սյան հանրագումարին): Դաշտերի արժեքները չեն կարող լինել բացասական։

Եթե նշված են nonCashAmount, bonusAmount, creditAmount և prepaymentAmount դաշտերի արժեքները և չի նշված cashAmount, ապա մնացած գումարը կվերագրվի cashAmount պարամետրին:

nonCashAmount

Decimal

api_conditionally required

Անկանխիկ վճարվող գումար:

posBank

String(20)

api_conditionally required

POS-տերմինալ տրամադրող բանկի կոդ:

posContract

String(3)

api_conditionally required

POS-տերմինալի տրամադրման պայմանագիր:

connectedDevice

Enum

api_optional

Միացված սարք։ Ընդունում է հետևյալ արժեքները․

1-ՀԴՄ-ի POS տերմինալ, 2-ARCUS 2 POS (Ingenico/SUNMI), 3-Possoft Pay POS (Feitian)

paymentSystem

Enum

api_optional

Վճարային համակարգ։ Ընդունում է հետևյալ արժեքները․ 1-ARCA, 2-VISA, 3-MASTER, 4-AMEX, 5-PayX, 6-Idram, 7-InecoPay, 9-Telcell, 10-MIR, 11-Քարտային վճարում

creditAmount

Decimal

api_conditionally required

Ապառիկ գումար:

prepaymentAmount

Decimal

api_conditionally required

Կանխավճարով մարվող գումար:

prepaymentCustomer

String(20)

api_conditionally required

Կանխավճարի գործընկեր:

prepaymentContract

String(3)

api_conditionally required

Կանխավճարի գործընկերոջ պայմանագիր:

changeAmount

Decimal

api_read_only

Մանր:

bonusAmount

Decimal

api_optional

Բոնուսով մարվող գումար:

addedBonus

Decimal

api_optional

Հաճախորդի բոնուսային միավորներին ավելացվող գումար։

accumulatedBonus

Decimal

api_read_only

Կուտակված բոնուս։

vatCalculationType

Enum

api_required

ԱԱՀ-ի հաշվարկի ձև. 1 - ԱԱՀ-ով, 2 - ԱԱՀ-ն այդ թվում,  3 - Առանց ԱԱՀ, 4 - Զրոյական ԱԱՀ:

priceType

String(2)

api_optional

api_reference type

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

discountPriceType

String(2)

api_optional

api_reference type

Զեղչի գնի տեսակի կոդ։

comment

String(255)

api_optional

Փաստաթղթի մեկնաբանություն։

owner

String(50)

api_optional

api_reference type

Հեղինակի կոդ:

discountPercent

Decimal

api_optional

Զեղչի տոկոս:

itemList [0..n]

Array

api_required

Ապրանքների և ծառայությունների անվանացուցակ (մասսիվ): Անվանացուցակը պետք է պարունակի ապրանքի կամ ծառայութան առնվազն մեկ տող։

 

Հաշվարկվում է համակարգի բիզնես տրամաբանությամբ․ ձեր կողմից փոխանցված ցանկացած արժեք կփոփոխվի համակարգի կողմից։

Անվանացուցակի տողի դաշտերը (itemList)

Անվանում

Տեսակ

Կիրառումը

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

type

Enum

api_read_only

Տողի տեսակ։ Ընդունում է հետևյալ արժեքները․

1-Ապրանք,

2-Ծառայություն:

storage

String(5)

api_optional

Պահեստի կոդ:

barcode

String(20)

api_read_only

Գծիկավոր կոդ:

id

Decimal

api_read_only

Ապրանքի կամ ծառայության ներքի նույնացուցիչ:

code

String(20)

api_required

Ապրանքի կամ ծառայության կոդ:

name

String(200)

api_conditionally required

Ապրանքի կամ ծառայության անվանում: Ծառայության դեպքում անվանումը կարելի է վերագրել։ Ապրանքի դեպքումը դաշտի արժեքը կանտեսվի։

unit

String(3)

api_optional

api_reference type

Ապրանքի կամ ծառայության չափման միավորի կոդ։

unitAbbreviation

String(6)

api_read_only

Ապրանքի կամ ծառայության չափման միավորի հապավում։

quantity

Decimal

api_required

Ապրանքի քանակը կամ ծառայության ծավալ:

salePrice

Decimal

api_required

Վաճառքի գին:

discountPercent

Decimal

api_optional

Զեղչի տոկոս:

discountedPrice

Decimal

api_optional

Զեղչված գին:

discountedAmount

Decimal

api_optional

Զեղչված գումար:

discountAmount

Decimal

api_read_only

Զեղչի գումար:

usedBonus

Decimal

api_optional

Օգտագործված բոնուս:

accumulatedBonus

Decimal

api_read_only

Կուտակված բոնուս:

vat

Boolean

api_optional

ԱԱՀ-ով հարկման հայտանիշ:

description

String(50)

api_optional

Տողի նկարագրություն:

deleted

Boolean

api_optional

Տողի հեռացված լինելու հայտանիշ։

gift

Boolean

api_optional

Նվերի հայտանիշ։

rowNumber

Decimal

api_read_only

Տողի համար։

rowId

Decimal

api_read_only

Տողի ներքին նույնացուցիչ։

cpaClassifier

String(12)

api_read_only

Ապրանքի դասակարգիչն է: Ընդունում է արժեքներ արտադրանքի դասակարգումն ըստ գործունեության տեսակների (ԱԴԳՏ) դասակարգիչների ցանկից:

markingList[]

Array

api_optional

Դրոշմավորման ծածկագրերի ցուցակ (մասսիվ):

 

POST

 

GET

hmtoggle_arrow1/v1/documents/salereturn/{isn}                                                                            

 

PUT

 

DELETE