Alle Lieferanten auflisten

GET /api/suppliers
<?xml version="1.0" encoding="UTF-8"?>
<suppliers type="array" page="1" per_page="100" total="2">
    <supplier>
        ...
    </supplier>
    <supplier>
        ...
    </supplier>
</suppliers>

Über Parameter kann gefiltert werden:

GET /api/suppliers?name=gmbh

Listet alle Lieferanten auf, die „gmbh“ im Namen haben. Groß- und Kleinschreibung wird ignoriert.
Folgende Parameter stehen zur Verfügung:

Parameter Beschreibung
name Firma/Bezeichnung des Lieferanten
email E-Mail-Adresse
first_name Vorname Ansprechpartner
last_name Nachname Ansprechpartner
country_code Ländercode nach ISO 3166 Alpha-2
creditor_identifier SEPA Gläubiger ID
note Notiz
client_number Kundennummer beim Lieferanten
incoming_id ID einer Eingangsrechnung für diesen Lieferanten, mehrere Werte kommasepariert
tags Kommaseparierte Liste der Schlagworte

Einzelnen Lieferanten aufrufen

GET /api/suppliers/{id}
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <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>
    <creditor_identifier>DE12ZZZ0123456789</creditor_identifier>
    <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>
    <currency_code>CHF</currency_code>    
    <note>Sehr netter Lieferant</note>
    <client_number>KD123</client_number>
    <costs_gross type="float">Kosten brutto</costs_gross> <!-- read only -->
    <costs_net type="float">Kosten netto</costs_net> <!-- read only -->
</supplier>

Lieferanten erstellen

POST /api/suppliers
XML-Element Beschreibung Typ Default-Wert Pflichtfeld
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.
creditor_identifier SEPA Gläubiger-ID gültige Gläubiger-ID
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
client_number Kundennummer beim Lieferanten ALNUM
currency_code Währung des Lieferanten. Ein leerer Wert bedeutet, dass die Account-Währung verwendet wird. ISO-Währungscode
<supplier>
    <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>
    <creditor_identifier>DE12ZZZ0123456789</creditor_identifier>
    <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>
</supplier>
<?xml version="1.0" encoding="UTF-8"?>
<supplier>
    <id type="integer">1234</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>    
    <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>
    <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>
    <creditor_identifier>DE12ZZZ0123456789</creditor_identifier>
    <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>
    <currency_code></currency_code>
    <note></note>
    <client_number></client_number>
    <costs_gross type="float">0</costs_gross>
    <costs_net type="float">0</costs_net>
</supplier>

Lieferanten bearbeiten

PUT /api/suppliers/{id}
<supplier>
    <name>Die super Musterfirma</name>
</supplier>
<supplier>
    <id type="integer">1234</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>    
    <name>Die super 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>
    <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>
    <creditor_identifier>DE12ZZZ0123456789</creditor_identifier>
    <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>
    <currency_code></currency_code>
    <note></note>
    <client_number></client_number>
    <costs_gross type="float">0</costs_gross>
    <costs_net type="float">0</costs_net>
</supplier>

Lieferanten löschen

DELETE /api/suppliers/{id}

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