Kunden

Attribute

Die Repräsentation des Kunden enthält ausserdem eine Kurzversion aller Projekte mit den wichtigsten Eigenschaften.

{
    "id": 760253573,
    "identifier": "C-123",
    "name": "Beispiel AG",
    "website": "",
    "phone": "",
    "fax": "",
    "billing_email": "",
    "billing_tax": 8.0,
    "currency": "CHF",
    "billing_address": "",
    "default_invoice_due_days": 20,
    "info": "",
    "custom_properties": {
        "UID": "1234-UID-4567"
    },
    "projects": [
        {
           "id": 944471929,
           "identifier": "P-123",
           "name": "Software Support",
           "active": false,
           "billable": true
        }
    ]
}


GET customers

Abruf aller Kunden:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/customers \
  -H 'Authorization: Token token={api-key}'

Die Antwort liefert ein Array mit vollständigen Kundeninformationen (siehe Attribute).


GET customers/{id}

Abruf eines einzelnen Kunden:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/customers/{123} \
  -H 'Authorization: Token token={api-key}'

Die Antwort ist die Repräsentation eines einzelnen Kunden.


POST customers

Erstellen eines Kunden:

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/customers \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'name=Beispiel AG&currency=EUR&identifier=K-123'

Pflichtfelder sind mit Stern (*) markiert:
  • name* – "Beispiel AG"
  • currency* – "EUR"
  • identifier* – "K-123" (nur Pflichtfeld, falls der Nummernkreis auf manuell gestellt ist)
  • billing_email – "kontakt@beispiel.de"
  • billing_address – "Beispiel AG\nBeispielstrasse 123\n12345 Berlin"
  • billing_tax – 19.0
  • custom_properties – {"UID": "123-UID-456"}
  • info – "Eine Info zum Kunden..."
  • default_invoice_due_days – 20
  • website – "www.beispiel.de"
  • phone – "+49 30 123 45 67"
  • fax – "+49 30 123 45 67


PUT customers/{id}

Aktualisieren eines Kunden:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/customers/{123} \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'name=Beispiel GmbH'

Felder sind analog zur Erstellung.


DELETE customers/{id}

Das Löschen eines Kunden ist über die API nicht möglich.


Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.