BTW-codes opvragen

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

BTW-codes opvragen

Aanroep

Naam: GetVatCodes

 

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:GetVatCodes xmlns:ns2="https://api.stip-t.nl/v1/">

    <securityToken></securityToken>

    <filters>

       <filter>

         <field></field>

         <operator></operator>

         <value></value>

       <filter>

       ...

     </filters>

     <orderBy></orderBy>

  </ns2:GetVatCodes>

</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 BTW-codes opgehaald

filterlijst voor VatCode 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.: vatCode, percentage DESC

 

Antwoord

Naam: GetVatCodesResponse

 

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:GetVatCodesResponse xmlns:ns2="https://api.stip-t.nl/v1/">

    <result>

      <error></error>

      <errorMessage/>

      <vatCodeList>

        <vatCode>

          <vatCode></vatCode>

          <description></description>

          <percentage></percentage>

          <ledgerVatToPay></ledgerVatToPay>

          <ledgerVatToClaim></ledgerVatToClaim>

        </vatCode>

      </vatCodeList>

    </result>

  </ns2:GetVatCodesResponse>

</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

vatCodeList

VatCodeList

Tag/veldnaam

Type

vatCode

VatCode

Tag/veldnaam

Type

Omschrijving

vatCode

string

BTW code

description

string

omschrijving

percentage

float

BTW percentage

ledgerVatToPay

string

grootboekrekening af te dragen BTW

ledgerVatToClaim

string

grootboekrekening te vorderen BTW