Factuur toevoegen

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

Factuur toevoegen

Aanroep

Naam: AddInvoice

 

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

    <securityToken></securityToken>

    <invoice>

      <date></date>

      <description></description>

      <layout></layout>

       <userFieldList>

        <userField>

          <key></key>

          <value></value>

        </userField>

         ...

      </userFieldList>

      <relation>

        <relationNo></relationNo>

        <name></name>

        <contact></contact>

        <address></address>

        <postalCode></postalCode>

        <city></city>

        <countryCode></countryCode>

        <email></email>

         <userFieldList>

          <userField>

            <key></key>

            <value></value>

          </userField>

           ...

        </userFieldList>

      </relation>

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

    </invoice>

    <createRelationIfNotExists></createRelationIfNotExists>

    <createProductIfNotExists></createProductIfNotExists>

  </ns2:AddInvoice>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

createRelationIfNotExists

boolean

default true

indien true, maak de relatie aan in Stip-T wanneer deze nog niet bestaat

createProductIfNotExists

boolean

default true

indien true, maak het artikel aan in Stip-T wanneer deze nog niet bestaat

invoice

Invoice

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

date

date

verplicht

factuurdatum

description

string

factuuromschrijving

layout

string

indien leeg, Stip-T default layout

factuurlayout

userFieldList

List<UserField>

Een factuur kan gebruikersvelden bevatten

zie UserField

relation

Relation

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

relationNo

string

- indien leeg én createRelationIfNotExists = true, dan wordt de relatie aangemaakt in Stip-T met een nieuw nummer

- indien onbekend én createRelationIfNotExists = true, dan wordt de relatie aangemaakt in Stip-T met dit nummer

relatie nummer

name

string

verplicht indien nieuwe relatie

indien leeg en relatie bestaat al, dan wordt de relatie naam overgenomen

naam

contact

string

indien leeg en relatie bestaat al, dan wordt de relatie contactpersoon overgenomen

contactpersoon

address

string

indien leeg en relatie bestaat al, dan wordt het relatie adres overgenomen

adres

postalCode

string

indien leeg en relatie bestaat al, dan wordt de relatie postcode overgenomen

postcode

city

string

indien leeg en relatie bestaat al, dan wordt de relatie plaats overgenomen

plaats

countryCode

string

verplicht

ISO 3166

indien leeg en relatie bestaat al, dan wordt de relatie landcode overgenomen

landcode

email

string

indien leeg en relatie bestaat al, dan wordt het relatie e-mail adres overgenomen

e-mail adres

userFieldList

List<UserField>

Een relatie kan gebruikersvelden bevatten

Alleen indien createRelationIfNotExists = true zullen de gegevens uit de gebruikersvelden worden opgeslagen bij de relatie

Lines

InvoiceLines

Tag/veldnaam

Type

line

InvoiceLine

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

quantity

float

aantal

discountPerc

float

kortingspercentage

product

Product

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

productNo

string

Indien productNo onbekend én createProductIfNotExists = true, dan wordt het artikel aangemaakt in Stip-T met dit nummer.

Indien geen productNo én createProductIfNotExists = false, dan zullen de description, unitPrice, ledgerAccNo en vatCode worden overgenomen naar de factuurregel, zonder dat deze gekoppeld wordt aan een artikel.

artikelnummer

description

string

verplicht indien nieuw artikel

indien leeg en artikel bestaat al, dan wordt de artikelomschrijving overgenomen

artikelomschrijving

unitPrice

float

mag niet 0 zijn

stuksprijs

ledgerAccNo

string

- indien leeg en artikel bestaat al, dan wordt de artikel omzet grootboekrekening overgenomen

- indien leeg en onbekend artikel, dan wordt de Stip-T standaard omzet grootboekrekening overgenomen

- anders verplicht gevuld

in alle gevallen moet de grootboekrekening reeds bestaan in Stip-T

omzet grootboekrekening

vatCode

string

- indien leeg en artikel bestaat al, dan wordt de artikel BTW-code overgenomen

- indien leeg en onbekend artikel, dan wordt Stip-T standaard BTW-code overgenomen

- anders verplicht gevuld

in alle gevallen moet de BTW-code reeds bestaan in Stip-T

BTW-code

userFieldList

List<UserField>

Een product kan gebruikersvelden bevatten

Alleen indien createProductIfNotExists = true zullen de gegevens uit de gebruikersvelden worden opgeslagen bij het artikel

 

Antwoord

Naam: AddInvoiceResponse

 

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:AddInvoiceResponse 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>

        </relation>

        <layout></layout>

        <Lines>

          <line>

            <product>

              <productNo></productNo>

              <description></description>

              <unitPrice></unitPrice>

              <ledgerAccNo></ledgerAccNo>

              <vatCode></vatCode>

            </product>

            <quantity></quantity>

            <discountPerc></discountPerc>

          </line>

        </Lines>

        <invoiceNo></invoiceNo>

        <token></token>

      </invoiceDetails>

    </result>

  </ns2:AddInvoiceResponse>

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

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