Grip API Dokumentation

Version 2.0 · /api/v2

Kundenorganisationen

Die Kundenorganisation ist die rechtliche Einheit, der ein Angebot unterbreitet wird. Sie enthält einen oder mehrere Kunden als Ansprechpartner. Beispiele: Unternehmen, Freiberufler, Handwerksbetrieb, Verein, Stiftung, Praxis, Kanzlei, Behörde etc.

Das Objekt `client_organization`

Das Objekt client_organization enthält alle Informationen zur Organisation des Kunden wie bspw. Organisationsname und Adresse.

client_organization

Eigenschaften

id integer: Eindeutige Kennung
Nur lesbar
name string: Name der Organisation
Pflicht
street string: Straße
zip string: PLZ
city string: Ort
country string: Land
Zweistelliger ISO Code, z.B. AT, CH, DE
website string: Web
URL inklusive Protokoll (http:// oder https://)
external_reference string: Referenznummer
default_rate decimal: Standardsatz
Stundensatz, Tagessatz oder Stückpreis in Verbindung mit default_rate_type
default_rate_type string: Einheit
Zulässige Werte: hour, day, piece
notes text: Bemerkungen
created_at datetime: Zeitpunkt der Erstellung
Nur lesbar
updated_at datetime: Zeitpunkt der letzten Änderung
Nur lesbar

Alle Kundenorganisationen auflisten

GET /client_organizations

Dieser Endpunkt ermöglicht das Auflisten aller Kundenorganisationen. Die gesamte Liste wird ohne Paginierung zurück gegeben. Die Attribute des Objekts sind im Abschnitt Das Objekt client_organization beschrieben.

Request

curl https://deinkonto.getgrip.de/api/v2/client_organizations \
    --header 'Authorization: Bearer {token}'

Response

{
  "data": [
    {
        "id": "6",
        "type": "client_organization",
        "attributes": {
            "name": "Personalberatung Drehtür AG",
            "street": "Potsdamer Straße 99",
            "zip": "11111",
            "city": "Berlin",
            "country": "DE",
            "website": "https://www.drehtuer.net",
            "external_reference": "888",
            "default_rate": "290.0",
            "default_rate_type": "hour",
            "notes": "Rabatt einkalkulieren und anbieten"
            "created_at": "2023-03-10T16:08:00.862+01:00",
            "updated_at": "2023-03-17T16:07:12.644+01:00"
        },
        "relationships": {
            "clients": {
                "data": [
                    {
                        "id": "46",
                        "type": "client"
                    }
                ]
            }
        }
    },
    {
        "id": "3",
        "type": "client_organization",
        // ...
    }
  ]
}

Kundenorganisation anlegen

POST /client_organizations

Dieser Endpunkt ermöglicht das Anlegen eines Objekts vom Typ client_organization. Der Request muss das Attribut "type" = "client_organization" enthalten. Die Attribute des Objekts sind im Abschnitt Das Objekt client_organization beschrieben.

Request

	curl https://deinkonto.getgrip.de/api/v2/client_organizations \
	--header 'Authorization: Bearer {token}' \
	--header 'Content-Type: application/json' \
	--data '{
	    "data": {
	      "type": "client_organization",
	        "attributes": {
	          "name": "MX Motorcycles AG",
	          "city": "Basel",
	          "country": "CH"
	        }
	    }
	  }'

Response

{
    "data": {
        "id": "220",
        "type": "client_organization",
        "attributes": {
            "name": "MX Motorcycles AG",
            "street": null,
            "zip": null,
            "city": "Basel",
            "country": "CH",
            "website": null,
            "external_reference": null,
            "default_rate": null,
            "default_rate_type": null,
            "notes": null,
            "created_at": "2023-03-24T17:14:32.352+01:00",
            "updated_at": "2023-03-24T17:14:32.352+01:00"
        },
        "relationships": {
            "clients": {
                "data": []
            }
        }
    }
}

Kundenorganisation abrufen

GET /client_organization/:id

Dieser Endpunkt ermöglicht das Abrufen einer einzelnen Kundenorganisation. Mit dem Request-Parameter include=clients können die Attribute aller Kunden dieser Kundenorganisation in die Abfrage einbezogen werden.

Request

curl https://deinkonto.getgrip.de/api/v2/client_organizations/220 \
    --header 'Authorization: Bearer {token}'

Response

{
    "data": {
        "id": "220",
        "type": "client_organization",
        "attributes": {
            "name": "MX Motorcycles AG",
            "street": null,
            "zip": null,
            "city": "Basel",
            "country": "CH",
            "website": null,
            "external_reference": null,
            "default_rate": null,
            "default_rate_type": null,
            "notes": null,
            "created_at": "2023-03-24T17:14:32.352+01:00",
            "updated_at": "2023-03-24T17:14:32.352+01:00"
        },
        "relationships": {
            "clients": {
                "data": []
            }
        }
    }
}

Kundenorganisation ändern

PUT /client_organization/:id

Dieser Endpunkt ermöglicht das Ändern eines Objekts vom Typ client_organization. Der Request muss die Attribute type und id enthalten. Die Attribute des Objekts sind im Abschnitt Das Objekt client_organization beschrieben.

Request

curl https://deinkonto.getgrip.de/api/v2/client_organizations/220 \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --request PUT \
  --data '{
    "data": {
      "type": "client_organization",
        "attributes": {
          "name": "MX e-Mobility AG"
        }
    }
  }'

Response

{
    "data": {
        "id": "220",
        "type": "client_organization",
        "attributes": {
            "name": "MX e-Mobility AG",
            "street": null,
            "zip": null,
            "city": "Basel",
            "country": "CH",
            "website": null,
            "external_reference": null,
            "default_rate": null,
            "default_rate_type": null,
            "notes": null,
            "created_at": "2023-03-24T17:14:32.352+01:00",
            "updated_at": "2023-03-24T17:47:53.680+01:00"
        },
        "relationships": {
            "clients": {
                "data": []
            }
        }
    }
}

Kundenorganisation löschen

DELETE /client_organization/:id

Dieser Endpunkt ermöglicht das Löschen einer Kundenorganisation. Beachte: die Löschung beinhaltet sämtliche Kunden in dieser Organisation. Das Löschen ist nur möglich, wenn keine Angebote für diese Kundenorganisation existieren.

Request

curl https://deinkonto.getgrip.de/api/v2/client_organizations/220 \
  --header 'Authorization: Bearer {token}' \
  --request DELETE