Unternehmensgruppen

Eine Gruppe sind die Gesellschaften, die ein Inhaber in Ocost führt. Ein API-Schlüssel kann für mehrere davon senden und lesen.

Was ein Schlüssel erreicht

Ein Schlüssel gehört zur Gesellschaft, in der er angelegt wurde, seinem Zuhause. Nur der Inhaber gibt ihm unter Einstellungen › Entwickler weitere Gesellschaften der Gruppe. Das ist eine Auswahl oder alle, auch später hinzugekommene. Auch der Ocost-Support kann sie festlegen, jede Änderung steht unter Einstellungen. Ein neuer Schlüssel erreicht nur sein Zuhause.

Das Geheimnis bleibt gleich, wenn sich seine Gesellschaften ändern. Eine Gesellschaft, die er nicht mehr erreicht oder die die Gruppe verlässt, lehnt Ocost ab der nächsten Anfrage ab.

GET /public/v1/businesses listet die Gesellschaften, die ein Schlüssel erreicht, sein Zuhause zuerst. Jeder Schlüssel darf das fragen.

Shell
curl -sS https://api.ocost.io/public/v1/businesses \
  -H "Authorization: Bearer $OCOST_KEY"
JSON
{
  "businesses": [
    { "id": "018f3c2a-7d1e-7b6a-9c40-2f5e8a1b3d77", "name": "Beispiel Holding GmbH", "own": true },
    { "id": "018f3c2a-9a04-7c21-8e5b-6d2f4c0a9e15", "name": "Beispiel Nord GmbH", "own": false },
    { "id": "018f3c2a-b5e7-7f42-9d13-4a8c2e6f1b09", "name": "Beispiel Süd GmbH", "own": false }
  ]
}

Die Gesellschaft nennen

Nennen Sie die Gesellschaft einer Anfrage mit dem Header Ocost-Business, ihrer ID. Der Header entscheidet, und Ocost leitet nichts um. Ohne ihn handelt die Anfrage im Zuhause des Schlüssels.

Shell
curl -sS https://api.ocost.io/public/v1/files \
  -H "Authorization: Bearer $OCOST_KEY" \
  -H "Ocost-Business: 018f3c2a-9a04-7c21-8e5b-6d2f4c0a9e15" \
  -F "file=@invoice.pdf"

Eine so geschickte Datei hat routed_by: header. Eine Gesellschaft, die der Schlüssel nicht erreicht, lehnt Ocost mit 403 urn:ocost:key:business ab. Ein Header, der keine ID ist, ergibt 400.

Den Beleg entscheiden lassen

Schicken Sie ohne Ocost-Business, leitet ein Schlüssel mit mehreren Gesellschaften die Datei um. Ocost liest sie im Zuhause des Schlüssels und sucht die Gesellschaften der Gruppe auf dem Beleg, bevor es etwas schreibt.

Es zählt nur eine exakte Kennung einer Gesellschaft:

Auf dem Belegrouted_by
USt-IdNr. oder eine andere Steuer- oder Firmennummer, etwa ІПН, NIP, EIN oder IDNOvat_id
Steuernummertax_number
ЄДРПОУ oder РНОКППedrpou
Registernummer mit Gerichtregister
Die IBAN der Gesellschaft, als Konto für die Zahlungiban

Eine Eingangsrechnung nennt die Gesellschaft als Käufer, eine Ausgangsrechnung als Verkäufer. Ein Vertrag kann jede Partei nennen. Eine im Zweifel gelesene Nummer zählt nie. Ein Name oder eine Adresse auch nicht.

Die Nummer einer Partei kann außerhalb ihres Blocks stehen, etwa im Verwendungszweck "… для ТОВ «Приклад» 42135797" oder in der Fußzeile. Ocost ordnet sie der Partei zu, hinter deren Namen sie steht. Trägt keine Partei die Nummer einer Gesellschaft, zählt eine irgendwo im Text. Die Gesellschaft des Verkäufers zählt so nie.

Der Beleg nenntDie Datei
Eine Gesellschaft mit ihrer KennungZieht dorthin um, mit routed_by wie oben
Keine Gesellschaft der GruppeBleibt im Zuhause des Schlüssels, mit routed_by: home
Zwei Gesellschaften, oder eine andere nur mit NamenWartet als needs_company im Zuhause

Eine umgezogene Datei behält ihre ID und zählt im Monat der Gesellschaft, in die sie umgezogen ist.

Eine wartende Datei zuordnen

Eine wartende Datei listet ihre candidates, jede mit why. Die Gesellschaften, die der Beleg nennt, kommen zuerst, das Zuhause des Schlüssels zuletzt.

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "status": "needs_company",
  "business_id": "018f3c2a-7d1e-7b6a-9c40-2f5e8a1b3d77",
  "routed_by": null,
  "candidates": [
    { "business_id": "018f3c2a-9a04-7c21-8e5b-6d2f4c0a9e15", "name": "Beispiel Nord GmbH", "why": "vat_id" },
    { "business_id": "018f3c2a-b5e7-7f42-9d13-4a8c2e6f1b09", "name": "Beispiel Süd GmbH", "why": "vat_id" },
    { "business_id": "018f3c2a-7d1e-7b6a-9c40-2f5e8a1b3d77", "name": "Beispiel Holding GmbH", "why": "home" }
  ]
}

In Ocost antworten der Inhaber oder die Buchhaltung unter Heute › Zuordnen. Oder antworten Sie vorher mit PATCH /public/v1/files/{file_id}:

Shell
curl -sS -X PATCH https://api.ocost.io/public/v1/files/$FILE_ID \
  -H "Authorization: Bearer $OCOST_KEY" \
  -H "Content-Type: application/json" \
  -d '{"business_id": "018f3c2a-9a04-7c21-8e5b-6d2f4c0a9e15"}'

Jede Antwort setzt routed_by: person. Die Gesellschaft muss eine sein, die Ihr Schlüssel und der sendende Schlüssel erreichen. Eine Datei, die nicht wartet, ergibt 409.

Dateien in der Gruppe finden

Ein Schlüssel, der keine Gesellschaft nennt, findet seine gesendeten Dateien in jeder Gesellschaft, die er erreicht. GET /public/v1/files/{file_id}, ihr Inhalt und ihr Beleg gehen allein über die ID der Datei. Ebenso DELETE.

GET /public/v1/files listet die Dateien des Zuhauses und die, die der Schlüssel anderswohin geschickt hat. business_id jeder Datei sagt, wo sie liegt. Der Parameter business_id behält die einer Gesellschaft:

Shell
curl -sS -G https://api.ocost.io/public/v1/files \
  -H "Authorization: Bearer $OCOST_KEY" \
  --data-urlencode "business_id=018f3c2a-9a04-7c21-8e5b-6d2f4c0a9e15"

Dieselben Bytes, die schon in einer erreichten Gesellschaft liegen, ergeben diese Datei. Ocost zählt sie einmal.

MCP in einer Gruppe

Der MCP-Server nimmt dieselben Schlüssel und denselben Header. send_file ohne Ocost-Business leitet um wie oben. Jedes andere Werkzeug handelt in der Gesellschaft, die der Header nennt, sonst im Zuhause des Schlüssels.

Siehe auch