ApexERPHost

<back to all web services

GetAvailableRefBooks

Requires Authentication
The following routes are available for this service:
GET/Accounting/Docs/{DocId}/References/Available
GET/Accounting/Docs/References/Available
GetAvailableRefBooks Parameters:
NameParameterData TypeRequiredDescription
DocIdpathstringNo
GetAvailableRefBooksResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<AvailableBookRef>No
AvailableBookRef Parameters:
NameParameterData TypeRequiredDescription
BookIdformstringNo
AvailableVgformdecimalNo
SourceDocformDocViewNo
AvailableVcformdecimal?No
DocView Parameters:
NameParameterData TypeRequiredDescription
DocIDformstringNo
DocTypeformintNo
BookTypeformintNo
OperIDformstringNo
CurrencyformCurrencyNo
DBViewformAccountInfoNo
CRViewformAccountInfoNo
DDateformDateTimeNo
NumberInformstringNo
NumberOutformstringNo
RSWaybillNumformstringNo
DocWaybillNumformstringNo
RSWaybillIDformint?No
VgformdecimalNo
ContentsformstringNo
VgCurrentformdecimal?No
OpDetIdformstringNo
CUserformstringNo
BookNoteformstringNo
TaxDocIdformlong?No
TaxDocNumformstringNo
TaxDocSerieformstringNo
Currency Parameters:
NameParameterData TypeRequiredDescription
CurrencyIDformstringNo
NameformstringNo
NameEnformstringNo
CodeformstringNo
CurTypeformintNo
ReCalcformboolNo
LastDateformDateTimeNo
RateformdecimalNo
SpendformboolNo
CurrencyCntformintNo
Currency_NformstringNo
LDefaultformboolNo
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
AccformstringNo
NameformstringNo
SNformstringNo
WarehouseAddressformstringNo
AddressformstringNo
PhoneformstringNo
AccWithNameformstringNo
VatTypeformintNo
BranchIdformint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Accounting/Docs/{DocId}/References/Available HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAvailableRefBooksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Accounting">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <AvailableBookRef>
      <BookId>String</BookId>
      <AvailableVg>0</AvailableVg>
      <SourceDoc>
        <DocID>String</DocID>
        <DocType>0</DocType>
        <BookType>0</BookType>
        <OperID>String</OperID>
        <Currency>
          <CurrencyID>String</CurrencyID>
          <Name>String</Name>
          <NameEn>String</NameEn>
          <Code>String</Code>
          <CurType>0</CurType>
          <ReCalc>false</ReCalc>
          <LastDate>0001-01-01T00:00:00</LastDate>
          <Rate>0</Rate>
          <Spend>false</Spend>
          <CurrencyCnt>0</CurrencyCnt>
          <Currency_N>String</Currency_N>
          <LDefault>false</LDefault>
        </Currency>
        <DBView>
          <Acc>String</Acc>
          <Name>String</Name>
          <SN>String</SN>
          <WarehouseAddress>String</WarehouseAddress>
          <Address>String</Address>
          <Phone>String</Phone>
          <AccWithName>String - String</AccWithName>
          <VatType>0</VatType>
          <BranchId>0</BranchId>
        </DBView>
        <CRView>
          <Acc>String</Acc>
          <Name>String</Name>
          <SN>String</SN>
          <WarehouseAddress>String</WarehouseAddress>
          <Address>String</Address>
          <Phone>String</Phone>
          <AccWithName>String - String</AccWithName>
          <VatType>0</VatType>
          <BranchId>0</BranchId>
        </CRView>
        <DDate>0001-01-01T00:00:00</DDate>
        <NumberIn>String</NumberIn>
        <NumberOut>String</NumberOut>
        <RSWaybillNum>String</RSWaybillNum>
        <DocWaybillNum>String</DocWaybillNum>
        <RSWaybillID>0</RSWaybillID>
        <Vg>0</Vg>
        <Contents>String</Contents>
        <VgCurrent>0</VgCurrent>
        <OpDetId>String</OpDetId>
        <CUser>String</CUser>
        <BookNote>String</BookNote>
        <TaxDocId>0</TaxDocId>
        <TaxDocNum>String</TaxDocNum>
        <TaxDocSerie>String</TaxDocSerie>
      </SourceDoc>
      <AvailableVc>0</AvailableVc>
    </AvailableBookRef>
  </Result>
</GetAvailableRefBooksResponse>