Kunden

Kostenlos testen

Alle Kun­den auflisten

GET /api/clients
<?xml version="1.0" encoding="UTF-8"?>
<clients type="array">
    <client>
        ...
    </client>
    <client>
        ...
    </client>
</clients>

Über Para­me­ter kann gefil­tert werden:

GET /api/clients?name=gmbh

Lis­tet alle Kun­den auf, die “gmbh” im Namen haben. Groß– und Klein­schrei­bung wird ignoriert.

Fol­gende Para­me­ter ste­hen zur Verfügung:

Para­me­ter Beschrei­bung
name Firma/Bezeichnung des Kunden
client_number Kun­den­num­mer
first_name Vor­name Ansprechpartner
last_name Nach­name Ansprechpartner
country_code Län­der­code nach ISO 3166 Alpha-2
note Notiz

Eigene Account-Informationen aufrufen

GET /api/clients/myself

Wird als ID “mys­elf” über­ge­ben, wer­den die Daten des eige­nen Accounts ausgegeben.

Ein­zel­nen Kun­den aufrufen

GET /api/clients/{id}
<?xml version="1.0" encoding="UTF-8"?>
<client>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <client_number>KD123</client_number>
    <number type="integer">123</number>
    <number_pre>KD</number_pre>
    <name>Musterfirma</name>
    <salutation>Herr</salutation>
    <first_name>Max</first_name>
    <last_name>Muster</last_name>
    <street>Musterstraße 123</street>
    <zip>12345</zip>
    <city>Musterstadt</city>
    <state>Bundesland</state>
    <country_code>DE</country_code>
    <phone>+49 123456789</phone>
    <fax>+49 123456789</fax>
    <mobile>+49 123456789</mobile>
    <email>info@example.com</email>
    <www>www.example.com</www>
    <tax_number>12/3456/789</tax_number>
    <vat_number>DE123456789</vat_number>
    <bank_account_owner>Kontoinhaber</bank_account_owner>
    <bank_number>123456789</bank_number>
    <bank_name>Deutsche Bank</bank_name>
    <bank_account_number>123456789</bank_account_number>
    <bank_swift>SWIFT/BIC</bank_swift>
    <bank_iban>IBAN</bank>
    <note>Sehr netter Kunde</note>
    <revenue_gross type="float">Umsatz brutto</revenue_gross> <!-- read only -->
    <revenue_net type="float">Umsatz netto</revenue_net> <!-- read only -->
</client>

Kun­den erstellen

POST /api/clients
XML-Element Beschrei­bung Typ Default-Wert Pflicht­feld
number_pre Prä­fix ALNUM Wert aus Ein­stel­lun­gen
num­ber lau­fende Nummer INT nächste freie Nummer
number_length Min­dest­länge der Kun­den­num­mer (wird mit füh­ren­den Nul­len aufgefüllt) INT Wert aus den Ein­stel­lun­gen
name Fir­men­name ALNUM
street Straße ALNUM
zip PLZ ALNUM
city Ort ALNUM
state Bun­des­land, Bezirk, Region ALNUM
country_code Land Län­der­code nach ISO 3166 Alpha-2 Wert aus eige­ner Firma
first_name Vor­name ALNUM
last_name Nach­name ALNUM
saluta­tion Anrede ALNUM
phone Tele­fon ALNUM
fax Fax ALNUM
email E-Mail gül­tige E-Mail-Adresse
www Web­site URL (ohne http)
tax_number Steu­er­num­mer ALNUM
vat_number Ust-IdNr. gül­tige Ust-IdNr.
bank_account_number Kon­to­num­mer ALNUM
bank_account_owner Kon­to­in­ha­ber ALNUM
bank_number BLZ ALNUM
bank_name Ban­k­name ALNUM
bank_swift SWIFT/BIC ALNUM
bank_iban IBAN gül­tige IBAN
note Notiz ALNUM 
<client>
    <name>Musterfirma</name>
    <salutation>Herr</salutation>
    <first_name>Max</first_name>
    <last_name>Muster</last_name>
    <street>Musterstraße 123</street>
    <zip>12345</zip>
    <city>Musterstadt</city>
    <state>Bundesland</state>
    <country_code>DE</country_code>
    <phone>+49 123456789</phone>
    <fax>+49 123456789</fax>
    <email>info@example.com</email>
    <www>www.example.com</www>
    <tax_number>12/3456/789</tax_number>
    <vat_number>DE123456789</vat_number>
    <bank_account_owner>Kontoinhaber</bank_account_owner>
    <bank_number>123456789</bank_number>
    <bank_name>Deutsche Bank</bank_name>
    <bank_account_number>123456789</bank_account_number>
    <bank_swift>SWIFT/BIC</bank_swift>
    <bank_iban>IBAN</bank_iban>
</client>

<?xml version="1.0" encoding="UTF-8"?>
<client>
    <id type="integer">1234</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <client_number>KD124</client_number>
    <number type="integer">124</number>
    <number_pre>KD</number_pre>
    <name>Musterfirma</name>
    <salutation>Herr</salutation>
    <first_name>Max</first_name>
    <last_name>Muster</last_name>
    <street>Musterstraße 123</street>
    <zip>12345</zip>
    <city>Musterstadt</city>
    <state>Bundesland</state>
    <country_code>DE</country>
    <phone>+49 123456789</phone>
    <fax>+49 123456789</fax>
    <email>info@example.com</email>
    <www>www.example.com</www>
    <tax_number>12/3456/789</tax_number>
    <vat_number>DE123456789</vat_number>
    <bank_account_owner>Kontoinhaber</bank_account_owner>
    <bank_number>123456789</bank_number>
    <bank_name>Deutsche Bank</bank_name>
    <bank_account_number>123456789</bank_account_number>
    <bank_swift>SWIFT/BIC</bank_swift>
    <bank_iban>IBAN</bank_iban>
    <note></note>
    <revenue_gross type="float">119.00</revenue_gross>
    <revenue_net type="float">100.00</revenue_net>
</client>

Kunde bear­bei­ten

PUT /api/clients/{id}
<client>
    <name>Die super Musterfirma</name>
</client>

Response: 200 OK

Kunde löschen

DELETE /api/clients/{id}

Ist nur mög­lich, wenn keine Doku­mente zu die­sem Kun­den existieren.

Response: 200 OK