Grootboekrekeningen opvragen

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

Grootboekrekeningen opvragen

Aanroep

Naam: GetLedgerAccounts

 

Aanroep structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetLedgerAccounts xmlns:ns2="https://api.stip-t.nl/v1/">

    <securityToken></securityToken>

    <filters>

       <filter>

         <field></field>

         <operator></operator>

         <value></value>

       <filter>

       ...

     </filters>

     <orderBy></orderBy>

  </ns2:GetLedgerAccounts>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

filters

List<Filter>

LET OP:

indien geen filters dan worden ALLE grootboekrekeningen opgehaald

filterlijst voor LedgerAccount velden (zie hieronder in de Antwoord structuur en Verklaring)

zie Filter

orderBy

string

sortering, komma gescheiden lijst van veldnamen. Een veldnaam kan gevolgd worden door sleutelwoord ASC (oplopend, default) of DESC (aflopend).

B.v.: ledgerAccNo, rgsCode DESC

 

Antwoord

Naam: GetLedgerAccountsResponse

 

Antwoord structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetLedgerAccountsResponse xmlns:ns2="https://api.stip-t.nl/v1/">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <ledgerAccountList>

        <ledgerAccount>

          <ledgerAccNo></ledgerAccNo>

          <description></description>

          <rgsCode></rgsCode>

        </ledgerAccount>

      </ledgerAccountList>

    </result>

  </ns2:GetLedgerAccountsResponse>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

result

RequestResult

Tag/veldnaam

Type

Omschrijving

error

boolean

false indien geen fouten, true indien er fouten zijn opgetreden

errorMessage

string

foutboodschap, alleen gevuld indien error = true

ledgerAccountList

LedgerAccountList

Tag/veldnaam

Type

ledgerAccount

LedgerAccount

Tag/veldnaam

Type

Omschrijving

ledgerAccNo

string

grootboekrekening nummer

description

string

grootboelrekening omschrijving

rgsCode

string

Referentie grootboekschema code