Clients

Try out for free

List all clients

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

The list can be fil­te­red with parameters:

GET /api/clients?name=gmbh

Shows all cli­ents with the term “gmbh” in their name. It doesn’t mat­ter if you use upper– or lowercase.

The fol­lo­wing para­me­ters can be used:

Para­me­ter Descrip­tion
name Com­pany name
client_number Cli­ent number
first_name First name of the con­tact person
last_name Last name of the con­tact person
country_code Coun­try code as ISO 3166 Alpha-2
note Note

Your own account info

GET /api/clients/myself

If you use “mys­elf” as ID, the data of your own account is returned.

Show a spe­ci­fic client

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>Mr</salutation>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <street>Teststreet 123</street>
    <zip>12345</zip>
    <city>Foo City</city>
    <state>Test State Island</state>
    <country_code>US</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>John Doe</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>
    <tax_rule>COUNTRY</tax_rule>
    <note>Really nice custumer</note>
    <revenue_gross type="float">1900</revenue_gross> <!-- read only -->
    <revenue_net type="float">1000</revenue_net> <!-- read only -->
</client>

Create a client

POST /api/clients
XML ele­ment Descrip­tion Type Default value Man­datory
number_pre Pre­fix ALNUM Value from set­tings
num­ber sequen­tial number INT next free number
number_length Mini­mum length of the cust­o­mer num­ber (to be fil­led with lea­ding zeros) INT Value from set­tings
name Com­pany name ALNUM
street Street ALNUM
zip PLZ ALNUM
city City ALNUM
state State, county, district, region ALNUM
country_code Coun­try Coun­try code as ISO 3166 Alpha-2 Value from your own com­pany
first_name First name ALNUM
last_name Last name ALNUM
saluta­tion Saluta­tion ALNUM
phone Phone ALNUM
fax Fax ALNUM
email Email valid Email addresse
www Web­site URL (w/o http)
tax_number Tax num­ber ALNUM
vat_number VAT num­ber valid VAT number
bank_account_number Bank account number ALNUM
bank_account_owner Bank account owner ALNUM
bank_number Bank iden­ti­fier code ALNUM
bank_name Bank name ALNUM
bank_swift SWIFT/BIC ALNUM
bank_iban IBAN valid IBAN
tax_rule Tax Rule TAX, NO_TAX, COUNTRY COUNTRY
note Note 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>
    <tax_rule>COUNTRY</tax_rule>
    <note></note>
    <revenue_gross type="float">119.00</revenue_gross>
    <revenue_net type="float">100.00</revenue_net>
</client>

Edit cli­ent

PUT /api/clients/{id}
<client>
    <name>ACME</name>
</client>

Response: 200 OK

Delete cli­ent

DELETE /api/clients/{id}

This is only pos­si­ble if no docu­ments exist for this client.

Response: 200 OK