GetDocumentsList

Ուղղորդիչ:  Վեբ-սերվիս (API) > Մատյաններ >

GetDocumentsList

Previous pageReturn to chapter overviewNext page

GetDocumentsList - վերադարձնում է ընտրման պայմաններին համապատասխանող փաստաթղթերի ցանկը` դրանց մասին կրճատ տեղեկություններով:

Վերադարձվող փաստաթղթերի ցանկը մեծ լինելու դեպքում, այն անհրաժեշտ է կարդալ մաս-մաս`GetDocumentsNextChunk մեթոդի օգնությամբ: Էջում տողերի առավելագույն քանակը 50 է:

Մուտքային տվյալներ

Ստորև ներկայացված է մուտքային տվյալների կառուցվածքը XML ֆորմատով.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

 <s:Header>

   <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://www.armsoft.am/Accountant/6.0/ITradeService/GetDocumentsList</Action>

 </s:Header>

 <s:Body>

   <GetDocumentsList xmlns="http://www.armsoft.am/Accountant/6.0">

     <sessionId>8a07edcc-f9d2-4b8d-8753-c934d07841c1</sessionId>

     <seqNumber>1</seqNumber>

     <DateBegin>2001-01-01T00:00:00</DateBegin>

     <DateEnd>2021-04-07T00:00:00</DateEnd>

     <DocTypesList />

     <CurrencyCode />

     <PartnerCode />

     <State>DraftOrProcessed</State>

   </GetDocumentsList>

 </s:Body>

</s:Envelope>

 

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

Պարամետր

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

Պարտադիր է

sessionId

Միացման նույնացուցիչ:

Այո

seqNumber

Հարցման հերթական համար:

Այո

DateBegin

Ժամանակահատվածի սկզբի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում:

Այո

DateEnd

Ժամանակահատվածի վերջի ամսաթիվ: Կվերադարձվեն այն փաստաթղթերը, որոնց ամսաթիվը ներառվում է նշված ժամանակահատվածում:

Այո

DocTypesList

Փաստաթղթերի տեսակների ցանկ` բաժանված ստորակետով (,): Ընդունում է հետևյալ արժեքները. Փաստաթղթերի տեսակներ:

Ոչ

PartnerCode

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

Ոչ

State

Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները.

0 / DraftOrProcessed - Գրանցված կամ սևագիր,

1 / Draft - Սևագիր,

2 / Processed - Գրանցված,

3 / Deleted  - Հեռացված:

Այո

 
Արդյունքային տվյալներ

Վերադարձնում է DocumentsListRow տիպի օբյեկտների ցանկը:

Ստորև ներկայացված է արդյունքային տվյալների կառուցվածքը XML ֆորմատով.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

 <s:Header />

 <s:Body>

   <GetDocumentsListResponse xmlns="http://www.armsoft.am/Accountant/6.0">

     <GetDocumentsListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

       <Total>116</Total>

       <Offset>0</Offset>

       <Rows>

         <DocumentsListRow>

           <ISN>af11aedb-8c95-431d-a43d-e851ec9ec5ba</ISN>

           <DocumentDate>2019-12-31T00:00:00</DocumentDate>

           <DocumentNumber>Մնացորդ</DocumentNumber>

           <DocumentState>Processed</DocumentState>

           <PartnerCode />

           <PartnerName />

           <CurrencyCode>AMD</CurrencyCode>

           <Amount>16000000.0000</Amount>

           <Comment>ՙԱԿԲԱ-Կրեդիտ Ագրիկոլ Բանկ՚ հ/հ մնացորդի մուտք</Comment>

         </DocumentsListRow>

          …  

       </Rows>

     </GetDocumentsListResult>

   </GetDocumentsListResponse>

 </s:Body>

</s:Envelope>

 

 

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

Անուն

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

Total

Ցանկում տողերի ընդհանուր քանակ: Offset պարամետրի հետ համատեղ թույլ է տալիս կազմակերպել էջ առ էջ ցանկի բեռնումը:

Offset

Կիրառվում է ցուցակի սկզբից ընթացիկ էջի շեղումը որոշելու համար: Վերադարձնում է ընթացիկ էջին նախորդող տողերի ընդհանուր քանակը:

Տես` Ամբողջական ցանկի բեռնման օրինակ

Rows

Մատյանի տողեր (մասսիվ):

Օբյեկտ DocumentsListRow (Rows օբյեկտի տողեր)  

ISN

Փաստաթղթի նույնացուցիչ {GUID}:

DocumentDate

Փաստաթղթի ամսաթիվ:

DocumentNumber

Փաստաթղթի համար:

DocumentState

Փաստաթղթի վիճակ: Ընդունում է հետևյալ արժեքները.

Draft - Սևագիր,

Processed - Գրանցված,

Deleted  - Հեռացված:

PartnerCode

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

PartnerName

Գործընկերոջ անվանում:

CurrencyCode

Փաստաթղթի արժույթ:

Amount

Փաստաթղթի գումար:

Comment

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