Alle Kunden auflisten

GET /api/clients
<?xml version="1.0" encoding="UTF-8"?>
<clients type="array" page="1" per_page="100" total="2">
    <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
email E-Mail-Adresse
first_name Vorname Ansprechpartner
last_name Nachname Ansprechpartner
country_code Ländercode nach ISO 3166 Alpha-2
note Notiz
invoice_id ID einer Rechnung für diesen Kunden, mehrere Werte kommasepariert
tags Kommaseparierte Liste der Schlagworte

Eigene Account-Informationen aufrufen

GET /api/clients/myself

Wird als ID „myself“ übergeben, werden die Daten des eigenen Accounts ausgegeben.

Einzelnen Kunden 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>
    <archived>0</archived>
    <client_number>KD123</client_number>
    <number type="integer">123</number>
    <number_pre>KD</number_pre>
    <number_length type="integer">0</number_length>
    <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>
    <address>Herr Max Muster
Musterstraße 123
12345 Musterstadt</address> <!-- read only -->
    <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_iban>
    <enable_customerportal>1</enable_customerportal>
    <customerportal_url>https://mybillomatid.billomat.net/customerportal/auth/autologin/entityId/123?hash=123456789aabbcc</customerportal_url>
    <sepa_mandate>MN123</sepa_mandate>
    <sepa_mandate_date>2013-12-10</sepa_mandate_date>
    <tax_rule>COUNTRY</tax_rule>
    <net_gross>SETTINGS</net_gross>
    <default_payment_types>CASH,PAPAL</default_payment_types>
    <reduction>10</reduction>
    <discount_rate_type>SETTINGS</discount_rate_type>
    <discount_rate>2</discount_rate>
    <discount_days_type>SETTINGS</discount_days_type>
    <discount_days>7</discount_days>
    <due_days_type>SETTINGS</due_days_type>
    <due_days>14</due_days>
    <reminder_due_days_type>RELATIVE</reminder_due_days_type>
    <reminder_due_days>-2</reminder_due_days>
    <offer_validity_days_type>ABSOLUTE</offer_validity_days_type>
    <offer_validity_days>30</offer_validity_days>
    <currency_code>CHF</currency_code>
    <price_group>2</price_group>
    <debitor_account_number>10000</debitor_account_number>
	<dunning_run>0</dunning_run>
    <note>Sehr netter Kunde</note>
    <revenue_gross type="float">119</revenue_gross> <!-- read only -->
    <revenue_net type="float">100</revenue_net> <!-- read only -->
</client>

Kunden erstellen

POST /api/clients
XML-Element Beschreibung Typ Default-Wert Pflichtfeld
archived Archivierungsstatus. Bei 1 ist der Kunde archiviert. BOOL 0
number_pre Präfix ALNUM Wert aus Einstellungen
number laufende Nummer INT nächste freie Nummer
number_length Mindestlänge der Kundennummer (wird mit führenden Nullen aufgefüllt) INT Wert aus den Einstellungen
name Firmenname ALNUM
street Straße ALNUM
zip PLZ ALNUM
city Ort ALNUM
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
mobile Mobiltelefon-Nummer ALNUM
email E-Mail gültige E-Mail-Adresse
www Website URL (ohne http)
tax_number Steuernummer ALNUM
vat_number Ust-IdNr. gültige Ust-IdNr.
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
sepa_mandate Mandatsreferenz eines SEPA-Lastschriftmandats ALNUM
sepa_mandate_date Ausstelldatum des SEPA-Lastschriftmandats DATE
locale Gebietsschema des Kunden. Wird kein Wert übergeben, bedeutet das, dass beim Kunden das Gebietsschema des Accounts angewendet wird. ALNUM
tax_rule Steuerregel TAX, NO_TAX, COUNTRY COUNTRY
net_gross Preisbasis (netto, brutto, gemäß Account-Einstellung) NET, GROSS, SETTINGS SETTINGS
default_payment_types Zahlart (z.B. CASH, BANK_TRANSFER, PAYPAL, …). Mehrere Zahlarten können per Komma getrennt werden und werden ODER-Verknüpft. Eine Übersicht aller Zahlarten findet man bei der API-Dokumentation für Zahlungen. Wird kein Wert übergeben, bedeutet das, dass dem Kunde die Zahlarten angeboten werden, die bei den Account-Einstellungen hinterlegt sind. ALNUM
note Notiz ALNUM
reduction Rabatt in Prozent FLOAT
discount_rate_type Typ des Standardwertes für Skonto-Satz SETTINGS, ABSOLUTE, RELATIVE SETTINGS
discount_rate Skonto-Satz FLOAT
discount_days_type Typ des Standardwertes für Skonto-Zeitraum SETTINGS, ABSOLUTE, RELATIVE SETTINGS
discount_days Skonto-Zeitraum in Tagen ab Rechnungsdatum FLOAT
due_days_type Typ des Standardwertes für Fälligkeit SETTINGS, ABSOLUTE, RELATIVE SETTINGS
due_days Fälligkeit in Tagen nach Rechnungsdatum INT
reminder_due_days_type Typ des Standardwertes für Mahnungsfälligkeit SETTINGS, ABSOLUTE, RELATIVE SETTINGS
reminder_due_days Mahnungsfälligkeit INT
offer_validity_days_type Typ des Standardwertes für Angebotsgültigkeit SETTINGS, ABSOLUTE, RELATIVE SETTINGS
offer_validity_days Gültigkeitsdauer für Angebote INT
currency_code Währung des Kunden. Ein leerer Wert bedeutet, dass die Account-Währung verwendet wird. ISO-Währungscode
price_group Preisgruppe. Artikel können mehrere Preise haben. Die Preisgruppe legt fest, welcher Preis für den Kunden gilt. INT
debitor_account_number Debitorennummer INT
dunning_run Automatischer Mahnlauf? BOOL
<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>
    <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_iban>
</client>
<?xml version="1.0" encoding="UTF-8"?>
<client>
    ...
</client>

Kunde bearbeiten

PUT /api/clients/{id}
<client>
    <name>Die super Musterfirma</name>
</client>
<?xml version="1.0" encoding="UTF-8"?>
<client>
    ...
</client>

Kunde löschen

DELETE /api/clients/{id}

Ist nur möglich, wenn keine Dokumente zu diesem Kunden existieren.

Kundenbild aufrufen

GET /api/clients/{id}/avatar?size={size}

Liefert das Kundenbild für den Kunden mit der übergebenen ID. Das Bild wird quadratisch zugeschnitten. Die Größe in Pixel kann über den Paramater size angegeben werden.