Factuur opvragen

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

Factuur opvragen

Aanroep

Naam: GetInvoice

 

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

    <securityToken></securityToken>

    <invoiceNo></invoiceNo>

  </ns2:GetInvoice>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

invoiceNo

string

verplicht

factuurnummer

 

Antwoord

Naam: GetInvoiceResponse

 

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

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <invoiceDetails>

        <date></date>

        <description></description>

         <userFieldList>

          <userField>

            <key></key>

            <value></value>

          </userField>

           ...

        </userFieldList>

         <totalAmount></totalAmount>

         <openAmount></openAmount>

        <relation>

          <relationNo></relationNo>

          <name></name>

          <contact></contact>

          <address></address>

          <postalCode></postalCode>

          <city></city>

          <countryCode></countryCode>

          <commerceNo></commerceNo>

          <taxNo></taxNo>

          <OIN></OIN>

          <email></email>

          <telephone></telephone>

           <userFieldList>

            <userField>

              <key></key>

              <value></value>

            </userField>

             ...

          </userFieldList>

        </relation>

        <layout></layout>

        <Lines>

          <line>

            <product>

              <productNo></productNo>

              <description></description>

              <unitPrice></unitPrice>

              <ledgerAccNo></ledgerAccNo>

              <vatCode></vatCode>

               <userFieldList>

                <userField>

                  <key></key>

                  <value></value>

                </userField>

                 ...

              </userFieldList>

            </product>

            <quantity></quantity>

            <discountPerc></discountPerc>

          </line>

        </Lines>

        <invoiceNo></invoiceNo>

        <token></token>

      </invoiceDetails>

    </result>

  </ns2:GetInvoiceResponse>

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

invoiceDetails

InvoiceDetails

Tag/veldnaam

Type

Omschrijving

date

date

factuurdatum

description

string

factuuromschrijving

layout

string

factuurlayout

invoiceNo

string

factuurnummer

token

string

token t.b.v. downloaden factuur in PDF of UBL formaat

zie: Factuur document opvragen

userFieldList

List<UserField>

Een factuur kan gebruikersvelden bevatten, zie UserField

totalAmount

float

Het totaalbedrag van de factuur, alleen ter informatie.

openAmount

float

Het openstaand bedrag van de factuur, alleen ter informatie.

relation

Relation

Tag/veldnaam

Type

Omschrijving

relationNo

string

relatie nummer

name

string

naam

contact

string

contactpersoon

address

string

adres

postalCode

string

postcode

city

string

plaats

countryCode

string

landcode

commerceNo

string

K.v.K. nummer

taxNo

string

BTW nummer

OIN

string

organisatie-identificatienummer overheidsorganisatie

email

string

e-mail adres

telephone

string

telefoonnummer

userFieldList

List<UserField>

Een relatie kan gebruikersvelden bevatten, zie UserField

Lines

InvoiceLines

Tag/veldnaam

Type

line

InvoiceLine

Tag/veldnaam

Type

Omschrijving

quantity

float

aantal

discountPerc

float

kortingspercentage

product

Product

Tag/veldnaam

Type

Omschrijving

productNo

string

artikelnummer

description

string

artikelomschrijving

unitPrice

float

stuksprijs

ledgerAccNo

string

omzet grootboekrekening

vatCode

string

BTW-code

userFieldList

List<UserField>

Een product kan gebruikersvelden bevatten, zie UserField