Firmen

Attribute

Die Repräsentation der Firma enthält neben den Standardfeldern folgende Eigenschaften.
  • Typ (customersupplierorganization)
  • Labels
  • Eigene Felder
{
    "id": 760253573,
    "type": "customer",
    "name": "Beispiel AG",
    "website": "www.beispiel-ag.com",
    "email": "info@beispiel-ag.com",
    "phone": "+49 30 123 45 67",
    "fax": "+49 30 123 45 66",
    "address": "Beispiel AG\nBeispielstrasse 123\n12345 Beispielstadt",
    "labels": ["Netzwerk", "Druckerei"],
    "info": "",
    "custom_properties": {
        "UID": "1234-UID-4567"
    },
}

...und ausserdem für Kunden zusätzliche Felder und eine Kurzversion aller Projekte mit den wichtigsten Eigenschaften

{ 
    ...
    "identifier": "C-123",
    "billing_tax": 8.0,
    "currency": "CHF",     
    "default_invoice_due_days": 20,
    "projects": [
        {
           "id": 944471929,
           "identifier": "P-123",
           "name": "Software Support",
           "active": false,
           "billable": true
        }
    ]
}

GET companies

Abruf aller Firmen:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/companies \
  -H 'Authorization: Token token={api-key}'
Zusätzlich sind folgende Filter-Parameter möglich:
  • type – ("customer", "supplier", "organization")
Die Antwort liefert ein Array mit vollständigen Firmeninformationen (siehe Attribute).

GET companies/{id}

Abruf einer einzelnen Firma:

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

Die Antwort ist die Repräsentation einer einzelnen Firma.

POST companies

Erstellen einer Firma:

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

Felder für alle Firmen – Pflichtfelder sind mit Stern (*) markiert:
  • name* – "Beispiel AG"
  • type* – ("customer", "supplier", "organization")
  • website – "http//www.lieferant.com"
  • fax – "+49 30 123 45 67"
  • phone – "+49 30 123 45 67"
  • email – "bestellung@lieferant.de"
  • address – "Lieferant AG\nBeispielstrasse 123\n12345 Berlin"
  • info – "Eine Info zur Firma..."
  • custom_properties – {"UID": "123-UID-456"}
  • labels – ["Netzwerk", "Druckerei"]
Zusätzliche Felder nur für Kunden (type=customer) – Pflichtfelder sind mit Stern (*) markiert:
  • currency* – "EUR"
  • identifier* – "K-123" (nur Pflichtfeld, falls der Nummernkreis auf manuell gestellt ist)
  • billing_tax – 19.0
  • default_invoice_due_days – 20

PUT companies/{id}

Aktualisieren einer Firma:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/companies/{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 companies/{id}

Das Löschen einer Firma ist über die API nicht möglich.

Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.