billomat[API]: Kunden

Alle Kunden auflisten

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

Über Parameter kann gefiltert werden:

GET /api/clients?name=gmbh

Listet alle Kunden auf, die "gmbh" im Namen haben. Groß- und Kleinschreibung wird ignoriert.

Folgende Parameter stehen zur Verfügung:

Parameter

Beschreibung

name

Firma/Bezeichnung des Kunden

client_number

Kundennummer

first_name

Vorname Ansprechpartner

last_name

Nachname Ansprechpartner

country_code

Ländercode nach ISO 3166 Alpha-2

note

Notiz

Einzelnen Kunden aufrufen

GET /api/clients/{id}
Response: 200 OK
<?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>

Kunden erstellen

POST /api/clients

Erstellt einen neuen Kunden.

XML-Element

Beschreibung

Typ

Default-Wert

Pflichtfeld

number_pre

Präfix

ALNUM

Wert aus Einstellungen

number

laufende Nummer

INT

nächste freie Nummer

name

Firmenname

ALNUM

street

Straße

ALNUM

ja

zip

PLZ

ALNUM

ja

city

Ort

ALNUM

ja

state

Bundesland, Bezirk, Region

ALNUM

country_code

Land

Ländercode nach ISO 3166 Alpha-2

Wert aus eigener Firma

first_name

Vorname

ALNUM

last_name

Nachname

ALNUM

salutation

Anrede

ALNUM

phone

Telefon

ALNUM

fax

Fax

ALNUM

email

E-Mail

gültige E-Mail-Adresse

www

Website

URL (ohne http)

tax_number

Steuernummer

ALNUM

vat_number

UstIdNr

gültige UstIdNr

bank_account_number

Kontonummer

ALNUM

bank_account_owner

Kontoinhaber

ALNUM

bank_number

BLZ

ALNUM

bank_name

Bankname

ALNUM

bank_swift

SWIFT/BIC

ALNUM

bank_iban

IBAN

gültige IBAN

note

Notiz

ALNUM

Request Body
<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>
Response: 201 Created
<?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 bearbeiten

PUT /api/clients/{id}

Aktualisiert einen Kunden mit den übergebenen Parametern.

Request Body
<client>
    <name>Die super Musterfirma</name>
</client>
Response: 200 OK

Kunde löschen

DELETE /api/clients/{id}

Löscht einen Kunden.

Ist nur möglich, wenn keine Angebote und Rechnungen zu diesem Kunden existieren.

Response: 200 OK
Du bist hier: Startseite » API » Kunden