API-Referenz

FOCUS

Exportieren Sie Ihre Rechnungen als FOCUS-Datensatz und lesen Sie die FOCUS-Abrechnungsdaten Ihrer Anbieter ein.

Mehr zu dieser Ressource

FOCUS ist das offene Format der FinOps Foundation für Abrechnungsdaten. Pleaxy arbeitet in beide Richtungen damit. Ein Export schreibt die Rechnungen, Belastungsanzeigen und akzeptierten Gutschriften des Workspace als FOCUS-Datensatz Cost and Usage, für ein FinOps- oder Reporting-Werkzeug. Eine FOCUS-Quelle liest Abrechnungsdaten in diesem Format, aus Dateien, die Sie hochladen, oder aus dem FOCUS-Export des Anbieters selbst, und speichert die Summen jedes Monats nach Rechnung, Aussteller und Kostenstelle. Export und Import werden je Workspace aktiviert; solange einer deaktiviert ist, antworten seine Endpunkte mit 404.

FOCUS-Exporte auflisten

Listet die FOCUS-Exporte der letzten 7 Tage auf und ob der Export aktiviert ist.

GET/v1/workspaces/{regionId}/focus-exports

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt zurück, ob der FOCUS-Export für den Workspace aktiviert ist, und seine Exporte der letzten 7 Tage, die neuesten zuerst, höchstens 20. Die Liste enthält keine Download-Links; rufen Sie sie mit GetFocusExport ab.

Braucht 'view'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Antwortfelder

  • enabledboolean

    Ob der FOCUS-Export für den Workspace aktiviert ist.

  • from, tostring

    Der erste und der letzte Abrechnungszeitraum des Exports, als YYYY-MM.

  • rowCount, documentCountnumber

    Die Zeilen im Datensatz und die Rechnungen, Belastungsanzeigen und Gutschriften, aus denen sie stammen.

  • expiresAtstring

    Wann Pleaxy die Dateien des Exports löscht, 7 Tage nach seiner Erstellung.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/focus-exports
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-exports" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "enabled": boolean,
   "exports": [
      {
         "id": "string",
         "status": "ready",
         "createdAt": "string",
         "version": "1.2" | "1.4",
         "include": "all" | "non_cloud",
         "from": "string",
         "to": "string",
         "format": "csv" | "parquet",
         "rowCount": number,
         "documentCount": number,
         "commitmentCount": number,
         "expiresAt": "string"
      }
   ]
}

FOCUS-Export erstellen

Exportiert die Rechnungen eines Bereichs von Monaten als FOCUS-Datensatz.

POST/v1/workspaces/{regionId}/focus-exports

Body

  • fromstringPflicht

    Der erste Abrechnungszeitraum, als YYYY-MM.

  • tostringPflicht

    Der letzte Abrechnungszeitraum, als YYYY-MM, einschließlich. Der Bereich umfasst höchstens 36 Monate.

  • version"1.2" | "1.4"

    Die FOCUS-Version. Fehlt sie, 1.2. Ein Export in 1.4 kann zusätzlich einen Datensatz Contract Commitment enthalten.

  • include"all" | "non_cloud"

    non_cloud lässt die Rechnungen von Cloud- und KI-Anbietern weg, die ein FinOps-Werkzeug aus den FOCUS-Exporten der Anbieter selbst lesen kann. Fehlt es, all.

  • format"csv" | "parquet"

    Das Dateiformat. Fehlt es, csv.

Rückgabe

201 Created mit dem in der Antwort gezeigten Objekt.

Weitere Details

Schreibt die Rechnungen, Belastungsanzeigen und akzeptierten Gutschriften des Workspace für die Abrechnungszeiträume from..to als FOCUS-Datensatz Cost and Usage mit einer Metadatendatei. Es gibt eine Zeile je Position, Steuereintrag und Anpassung; Gutschriften sind negativ; Beträge bleiben in der Währung des jeweiligen Dokuments. Die Antwort enthält Download-Links, die 15 Minuten gültig sind, und die Dateien werden 7 Tage aufbewahrt. Ein Export ändert nichts im Workspace.

Braucht 'view'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Antwortfelder

  • from, tostring

    Der erste und der letzte Abrechnungszeitraum des Exports, als YYYY-MM.

  • rowCount, documentCountnumber

    Die Zeilen im Datensatz und die Rechnungen, Belastungsanzeigen und Gutschriften, aus denen sie stammen.

  • expiresAtstring

    Wann Pleaxy die Dateien des Exports löscht, 7 Tage nach seiner Erstellung.

  • downloadUrl, metadataUrlstring

    Links zum Datensatz und zu seiner Metadatendatei, 15 Minuten gültig. Rufen Sie GetFocusExport für neue Links auf.

  • commitmentsUrlstring

    Ein Link zum Datensatz Contract Commitment, nur vorhanden, wenn der Export einen hat.

Fehler

  • 400 Bad Request - from oder to ist kein Monat in der Schreibweise YYYY-MM, from liegt nach to, oder der Bereich umfasst mehr als 36 Monate.
  • 404 Not Found - Der FOCUS-Export ist für diesen Workspace nicht aktiviert ("FOCUS export isn't switched on for this workspace yet.").
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
POST /v1/workspaces/{regionId}/focus-exports
Anfrage
POST /v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.buyer/focus-exports
{
   "from": "2026-07",
   "to": "2026-09",
   "include": "non_cloud"
}
Antwort · 201 Created
{
   "id": "FE-mhu8x2k04f9a1c",
   "status": "ready",
   "createdAt": "2026-11-11T15:04:05.000Z",
   "version": "1.2",
   "include": "non_cloud",
   "from": "2026-07",
   "to": "2026-09",
   "format": "csv",
   "rowCount": 412,
   "documentCount": 57,
   "expiresAt": "2026-11-18T15:04:05.000Z",
   "downloadUrl": "https://...",
   "metadataUrl": "https://..."
}

FOCUS-Export abrufen

Ruft einen FOCUS-Export mit neuen Download-Links ab.

GET/v1/workspaces/{regionId}/focus-exports/{exportId}

Parameter

  • exportIdstringPflicht

    Die id des Exports, wie CreateFocusExport sie zurückgibt.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt einen Export der letzten 7 Tage mit neuen Links zu seinem Datensatz und seiner Metadatendatei zurück, 15 Minuten gültig.

Braucht 'view'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Antwortfelder

  • from, tostring

    Der erste und der letzte Abrechnungszeitraum des Exports, als YYYY-MM.

  • rowCount, documentCountnumber

    Die Zeilen im Datensatz und die Rechnungen, Belastungsanzeigen und Gutschriften, aus denen sie stammen.

  • expiresAtstring

    Wann Pleaxy die Dateien des Exports löscht, 7 Tage nach seiner Erstellung.

  • downloadUrl, metadataUrlstring

    Links zum Datensatz und zu seiner Metadatendatei, 15 Minuten gültig. Rufen Sie GetFocusExport für neue Links auf.

  • commitmentsUrlstring

    Ein Link zum Datensatz Contract Commitment, nur vorhanden, wenn der Export einen hat.

Fehler

  • 404 Not Found - Kein Export in diesem Workspace hat diese id, er ist abgelaufen (Exporte werden 7 Tage aufbewahrt), oder der FOCUS-Export ist für diesen Workspace nicht aktiviert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/focus-exports/{exportId}
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-exports/{exportId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "id": "string",
   "status": "ready",
   "createdAt": "string",
   "version": "1.2" | "1.4",
   "include": "all" | "non_cloud",
   "from": "string",
   "to": "string",
   "format": "csv" | "parquet",
   "rowCount": number,
   "documentCount": number,
   "commitmentCount": number,
   "expiresAt": "string",
   "downloadUrl": "string",
   "metadataUrl": "string",
   "commitmentsUrl": "string"
}

FOCUS-Quellen auflisten

Listet die FOCUS-Quellen des Workspace mit ihrem letzten Lauf auf und ob der Import aktiviert ist.

GET/v1/workspaces/{regionId}/focus-sources

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt zurück, ob der FOCUS-Import aktiviert ist, und die FOCUS-Quellen des Workspace, jeweils mit ihrem letzten Lauf, den gespeicherten Monaten und ihren häufigsten Tag-Schlüsseln.

Braucht 'view'-Zugriff auf Rechnungen.

Antwortfelder

  • enabledboolean

    Ob der FOCUS-Import für den Workspace aktiviert ist.

  • kindstring

    upload: Dateien, die Sie hochladen. aws_s3: ein FOCUS-Export von AWS Data Exports. azure_blob: ein FOCUS-Export von Azure Cost Management. gcp_bigquery: die FOCUS-Tabelle von Google Cloud. oci: die FOCUS-Berichte von Oracle Cloud. s3_compatible: ein Bucket auf einem beliebigen S3-kompatiblen Speicher.

  • periodsArray<string>

    Die Monate, für die die Quelle Zahlen gespeichert hat, als YYYY-MM.

  • lastRunobject

    Der letzte Lesevorgang: die gelesenen Monate, Dateien und Zeilen, die übersprungenen Zeilen nach Grund und failure.reason, wenn status failed ist.

  • tagKeysArray<string>

    Die häufigsten Tag-Schlüssel in den Zeilen der Quelle.

  • s3.keyHintstring

    Ein kurzer Hinweis darauf, welcher geheime Zugriffsschlüssel gespeichert ist. Das Geheimnis selbst wird nie zurückgegeben.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/focus-sources
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "enabled": boolean,
   "sources": [
      {
         "id": "string",
         "kind": "upload" | "aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible",
         "label": "string",
         "provider": "aws" | "azure" | "gcp" | "oci",
         "connectionId": "string",
         "aws": { "bucket": "string", "prefix": "string", "region": "string" },
         "azure": { "storageAccount": "string", "container": "string", "directory": "string" },
         "gcp": { "table": "string" },
         "oci": { "region": "string" },
         "s3": { "endpoint": "string", "region": "string", "bucket": "string", "prefix": "string", "accessKeyId": "string", "keyHint": "string" },
         "periods": [ "string" ],
         "lastRun": {
            "runId": "string",
            "startedAt": "string",
            "finishedAt": "string",
            "status": "ok" | "partial" | "failed",
            "trigger": "schedule" | "manual" | "upload",
            "periods": [ "string" ],
            "files": number,
            "rows": number,
            "skipped": number,
            "skippedByReason": { "noBillingPeriod": number, "badNumber": number, "badCurrency": number, "badChargePeriod": number },
            "ignoredFiles": number,
            "version": "string",
            "failure": { "reason": "accessDenied" | "notFound" | "wrongRegion" | "notFocus" | "parquetUnsupported" | "connectionMissing" | "credentialRejected" | "unreachable" | "other", "detail": "string" }
         },
         "tagKeys": [ "string" ],
         "commitments": [ { "id": "string", "contractId": "string", "category": "string", "type": "string", "periodStart": "string", "periodEnd": "string", "cost": number, "currency": "string" } ],
         "createdAt": "string",
         "updatedAt": "string"
      }
   ]
}

FOCUS-Quelle erstellen

Fügt den FOCUS-Export eines Anbieters als Quelle hinzu, die Pleaxy täglich liest.

POST/v1/workspaces/{regionId}/focus-sources

Body

  • kind"aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible"Pflicht

    Wo die FOCUS-Daten liegen. Senden Sie daneben das Objekt desselben Anbieters.

  • labelstring

    Optional. Ein Name für die Quelle.

  • connectionIdstring

    Die Cloud-Verbindung, zu der die Quelle gehört, wie ListCloudConnections sie zurückgibt. Erforderlich für jede Art außer s3_compatible.

  • awsobject

    Für aws_s3: der Bucket, in den AWS Data Exports schreibt, das Präfix des Exports (sein S3-Präfix und der Exportname) und die Region des Buckets.

  • azureobject

    Für azure_blob: das Speicherkonto, der Container und das Verzeichnis des Exports.

  • gcpobject

    Für gcp_bigquery: die FOCUS-Tabelle oder -Ansicht, als project.dataset.table.

  • ociobject

    Für oci: die Home-Region des Mandanten.

  • s3object

    Für s3_compatible: der HTTPS-Endpunkt, die Region, der Bucket und das Präfix des Speichers sowie ein Zugriffsschlüssel, der ihn lesen kann. Das Geheimnis wird verschlüsselt gespeichert und nie zurückgegeben.

Rückgabe

201 Created mit dem in der Antwort gezeigten Objekt.

Weitere Details

Fügt eine FOCUS-Quelle hinzu. Die Quelle einer Cloud (aws_s3, azure_blob, gcp_bigquery oder oci) gehört zu einer Cloud-Verbindung des Workspace beim selben Anbieter; sie wird dann zur Quelle der KI-Positionen dieser Verbindung, anstelle des eigenen KI-Lesevorgangs des Connectors. Eine Quelle vom Typ s3_compatible bringt ihren eigenen Zugriffsschlüssel mit. Pleaxy liest eine Quelle täglich und mit SyncFocusSource sofort. Eine Verbindung hat höchstens eine FOCUS-Quelle.

Nur angemeldete Sitzung, mit 'edit'-Zugriff auf Rechnungen: Eine Quelle öffnet einen Lesezugang in Ihr Cloud-Konto, deshalb fügt eine Person sie hinzu und entfernt sie.

Antwortfelder

  • kindstring

    upload: Dateien, die Sie hochladen. aws_s3: ein FOCUS-Export von AWS Data Exports. azure_blob: ein FOCUS-Export von Azure Cost Management. gcp_bigquery: die FOCUS-Tabelle von Google Cloud. oci: die FOCUS-Berichte von Oracle Cloud. s3_compatible: ein Bucket auf einem beliebigen S3-kompatiblen Speicher.

  • periodsArray<string>

    Die Monate, für die die Quelle Zahlen gespeichert hat, als YYYY-MM.

  • lastRunobject

    Der letzte Lesevorgang: die gelesenen Monate, Dateien und Zeilen, die übersprungenen Zeilen nach Grund und failure.reason, wenn status failed ist.

  • tagKeysArray<string>

    Die häufigsten Tag-Schlüssel in den Zeilen der Quelle.

  • s3.keyHintstring

    Ein kurzer Hinweis darauf, welcher geheime Zugriffsschlüssel gespeichert ist. Das Geheimnis selbst wird nie zurückgegeben.

Fehler

  • 400 Bad Request - Ein Feld fehlt oder ist ungültig, die Verbindung gehört zu einer anderen Cloud als kind, oder die Verbindung hat bereits eine FOCUS-Quelle.
  • 403 Forbidden - Der Aufrufer ist keine angemeldete Person (zum Beispiel ein API-Schlüssel) oder hat keinen 'edit'-Zugriff auf Rechnungen.
  • 404 Not Found - Keine Cloud-Verbindung in diesem Workspace hat diese connectionId, oder der FOCUS-Import ist für diesen Workspace nicht aktiviert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
POST /v1/workspaces/{regionId}/focus-sources
Anfrage
curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json
body.json
{
   "kind": "aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible",
   "label": "string",
   "connectionId": "string",
   "aws": { "bucket": "string", "prefix": "string", "region": "string" },
   "azure": { "storageAccount": "string", "container": "string", "directory": "string" },
   "gcp": { "table": "string" },
   "oci": { "region": "string" },
   "s3": { "endpoint": "string", "region": "string", "bucket": "string", "prefix": "string", "accessKeyId": "string", "secretAccessKey": "string" }
}
Antwort · 201 Created
{
   "id": "string",
   "kind": "upload" | "aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible",
   "label": "string",
   "provider": "aws" | "azure" | "gcp" | "oci",
   "connectionId": "string",
   "aws": { "bucket": "string", "prefix": "string", "region": "string" },
   "azure": { "storageAccount": "string", "container": "string", "directory": "string" },
   "gcp": { "table": "string" },
   "oci": { "region": "string" },
   "s3": { "endpoint": "string", "region": "string", "bucket": "string", "prefix": "string", "accessKeyId": "string", "keyHint": "string" },
   "periods": [ "string" ],
   "lastRun": {
      "runId": "string",
      "startedAt": "string",
      "finishedAt": "string",
      "status": "ok" | "partial" | "failed",
      "trigger": "schedule" | "manual" | "upload",
      "periods": [ "string" ],
      "files": number,
      "rows": number,
      "skipped": number,
      "skippedByReason": { "noBillingPeriod": number, "badNumber": number, "badCurrency": number, "badChargePeriod": number },
      "ignoredFiles": number,
      "version": "string",
      "failure": { "reason": "accessDenied" | "notFound" | "wrongRegion" | "notFocus" | "parquetUnsupported" | "connectionMissing" | "credentialRejected" | "unreachable" | "other", "detail": "string" }
   },
   "tagKeys": [ "string" ],
   "commitments": [ { "id": "string", "contractId": "string", "category": "string", "type": "string", "periodStart": "string", "periodEnd": "string", "cost": number, "currency": "string" } ],
   "createdAt": "string",
   "updatedAt": "string"
}

FOCUS-Quelle abrufen

Ruft eine FOCUS-Quelle mit ihrem letzten Lauf ab.

GET/v1/workspaces/{regionId}/focus-sources/{sourceId}

Parameter

  • sourceIdstringPflicht

    Die id der FOCUS-Quelle, wie ListFocusSources sie zurückgibt.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt eine FOCUS-Quelle mit ihrem letzten Lauf zurück. Fragen Sie sie nach SyncFocusSource oder CompleteFocusUpload ab, um zu sehen, wann der Lesevorgang beendet ist.

Braucht 'view'-Zugriff auf Rechnungen.

Antwortfelder

  • kindstring

    upload: Dateien, die Sie hochladen. aws_s3: ein FOCUS-Export von AWS Data Exports. azure_blob: ein FOCUS-Export von Azure Cost Management. gcp_bigquery: die FOCUS-Tabelle von Google Cloud. oci: die FOCUS-Berichte von Oracle Cloud. s3_compatible: ein Bucket auf einem beliebigen S3-kompatiblen Speicher.

  • periodsArray<string>

    Die Monate, für die die Quelle Zahlen gespeichert hat, als YYYY-MM.

  • lastRunobject

    Der letzte Lesevorgang: die gelesenen Monate, Dateien und Zeilen, die übersprungenen Zeilen nach Grund und failure.reason, wenn status failed ist.

  • tagKeysArray<string>

    Die häufigsten Tag-Schlüssel in den Zeilen der Quelle.

  • s3.keyHintstring

    Ein kurzer Hinweis darauf, welcher geheime Zugriffsschlüssel gespeichert ist. Das Geheimnis selbst wird nie zurückgegeben.

Fehler

  • 404 Not Found - Keine FOCUS-Quelle in diesem Workspace hat diese id, oder der FOCUS-Import ist für diesen Workspace nicht aktiviert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/focus-sources/{sourceId}
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/{sourceId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "id": "string",
   "kind": "upload" | "aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible",
   "label": "string",
   "provider": "aws" | "azure" | "gcp" | "oci",
   "connectionId": "string",
   "aws": { "bucket": "string", "prefix": "string", "region": "string" },
   "azure": { "storageAccount": "string", "container": "string", "directory": "string" },
   "gcp": { "table": "string" },
   "oci": { "region": "string" },
   "s3": { "endpoint": "string", "region": "string", "bucket": "string", "prefix": "string", "accessKeyId": "string", "keyHint": "string" },
   "periods": [ "string" ],
   "lastRun": {
      "runId": "string",
      "startedAt": "string",
      "finishedAt": "string",
      "status": "ok" | "partial" | "failed",
      "trigger": "schedule" | "manual" | "upload",
      "periods": [ "string" ],
      "files": number,
      "rows": number,
      "skipped": number,
      "skippedByReason": { "noBillingPeriod": number, "badNumber": number, "badCurrency": number, "badChargePeriod": number },
      "ignoredFiles": number,
      "version": "string",
      "failure": { "reason": "accessDenied" | "notFound" | "wrongRegion" | "notFocus" | "parquetUnsupported" | "connectionMissing" | "credentialRejected" | "unreachable" | "other", "detail": "string" }
   },
   "tagKeys": [ "string" ],
   "commitments": [ { "id": "string", "contractId": "string", "category": "string", "type": "string", "periodStart": "string", "periodEnd": "string", "cost": number, "currency": "string" } ],
   "createdAt": "string",
   "updatedAt": "string"
}

FOCUS-Quelle synchronisieren

Liest eine FOCUS-Quelle jetzt, im Hintergrund.

POST/v1/workspaces/{regionId}/focus-sources/{sourceId}/sync

Parameter

  • sourceIdstringPflicht

    Die id der FOCUS-Quelle, wie ListFocusSources sie zurückgibt.

Rückgabe

202 Accepted mit dem in der Antwort gezeigten Objekt.

Weitere Details

Startet im Hintergrund einen Lesevorgang der Quelle, der die enthaltenen Monate erneut liest, und gibt die Quelle zurück. Ihr lastRun zeigt das Ergebnis, sobald der Lesevorgang beendet ist.

Braucht 'edit'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Antwortfelder

  • kindstring

    upload: Dateien, die Sie hochladen. aws_s3: ein FOCUS-Export von AWS Data Exports. azure_blob: ein FOCUS-Export von Azure Cost Management. gcp_bigquery: die FOCUS-Tabelle von Google Cloud. oci: die FOCUS-Berichte von Oracle Cloud. s3_compatible: ein Bucket auf einem beliebigen S3-kompatiblen Speicher.

  • periodsArray<string>

    Die Monate, für die die Quelle Zahlen gespeichert hat, als YYYY-MM.

  • lastRunobject

    Der letzte Lesevorgang: die gelesenen Monate, Dateien und Zeilen, die übersprungenen Zeilen nach Grund und failure.reason, wenn status failed ist.

  • tagKeysArray<string>

    Die häufigsten Tag-Schlüssel in den Zeilen der Quelle.

  • s3.keyHintstring

    Ein kurzer Hinweis darauf, welcher geheime Zugriffsschlüssel gespeichert ist. Das Geheimnis selbst wird nie zurückgegeben.

Fehler

  • 400 Bad Request - Die Quelle ist die Upload-Quelle, die gelesen wird, wenn eine Datei eintrifft: Laden Sie die Datei erneut hoch, um sie neu zu lesen.
  • 404 Not Found - Keine FOCUS-Quelle in diesem Workspace hat diese id, oder der FOCUS-Import ist für diesen Workspace nicht aktiviert.
  • 503 Service Unavailable - Der Lesevorgang kann gerade nicht gestartet werden. Versuchen Sie es in ein paar Minuten erneut.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
POST /v1/workspaces/{regionId}/focus-sources/{sourceId}/sync
Anfrage
curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/{sourceId}/sync" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 202 Accepted
{
   "id": "string",
   "kind": "upload" | "aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible",
   "label": "string",
   "provider": "aws" | "azure" | "gcp" | "oci",
   "connectionId": "string",
   "aws": { "bucket": "string", "prefix": "string", "region": "string" },
   "azure": { "storageAccount": "string", "container": "string", "directory": "string" },
   "gcp": { "table": "string" },
   "oci": { "region": "string" },
   "s3": { "endpoint": "string", "region": "string", "bucket": "string", "prefix": "string", "accessKeyId": "string", "keyHint": "string" },
   "periods": [ "string" ],
   "lastRun": {
      "runId": "string",
      "startedAt": "string",
      "finishedAt": "string",
      "status": "ok" | "partial" | "failed",
      "trigger": "schedule" | "manual" | "upload",
      "periods": [ "string" ],
      "files": number,
      "rows": number,
      "skipped": number,
      "skippedByReason": { "noBillingPeriod": number, "badNumber": number, "badCurrency": number, "badChargePeriod": number },
      "ignoredFiles": number,
      "version": "string",
      "failure": { "reason": "accessDenied" | "notFound" | "wrongRegion" | "notFocus" | "parquetUnsupported" | "connectionMissing" | "credentialRejected" | "unreachable" | "other", "detail": "string" }
   },
   "tagKeys": [ "string" ],
   "commitments": [ { "id": "string", "contractId": "string", "category": "string", "type": "string", "periodStart": "string", "periodEnd": "string", "cost": number, "currency": "string" } ],
   "createdAt": "string",
   "updatedAt": "string"
}

FOCUS-Quelle löschen

Entfernt eine FOCUS-Quelle mit den Monaten, die sie gespeichert hat.

DELETE/v1/workspaces/{regionId}/focus-sources/{sourceId}

Parameter

  • sourceIdstringPflicht

    Die id der FOCUS-Quelle, wie ListFocusSources sie zurückgibt.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Entfernt die Quelle mit den Monaten und KI-Positionen, die sie gespeichert hat. Der eigene KI-Lesevorgang des Connectors läuft für ihre Cloud-Verbindung wieder an.

Nur angemeldete Sitzung, mit 'edit'-Zugriff auf Rechnungen: Eine Quelle öffnet einen Lesezugang in Ihr Cloud-Konto, deshalb fügt eine Person sie hinzu und entfernt sie.

Fehler

  • 403 Forbidden - Der Aufrufer ist keine angemeldete Person (zum Beispiel ein API-Schlüssel) oder hat keinen 'edit'-Zugriff auf Rechnungen.
  • 404 Not Found - Keine FOCUS-Quelle in diesem Workspace hat diese id, oder der FOCUS-Import ist für diesen Workspace nicht aktiviert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
DELETE /v1/workspaces/{regionId}/focus-sources/{sourceId}
Anfrage
curl -X DELETE "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/{sourceId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "removed": true
}

Zeitraum einer FOCUS-Quelle abrufen

Ruft einen gespeicherten Monat einer FOCUS-Quelle ab, nach Rechnung, Kostenstelle und Aussteller.

GET/v1/workspaces/{regionId}/focus-sources/{sourceId}/periods/{period}

Parameter

  • sourceIdstringPflicht

    Die id der FOCUS-Quelle, wie ListFocusSources sie zurückgibt.

  • periodstringPflicht

    Der Monat, als YYYY-MM.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt einen gespeicherten Monat einer Quelle zurück: seine Summen nach Währung, jede Rechnung nach Nummer mit ihren Beträgen nach Kategorie und Dienst, die Ausgaben nach Kostenstelle und die Summen nach Aussteller.

Braucht 'view'-Zugriff auf Rechnungen.

Antwortfelder

  • totalsobject

    Die berechnete Summe des Monats, nach Währungscode.

  • invoicesArray<object>

    Jede Rechnung, die die Zeilen des Monats nennen, mit ihrer Summe und ihren Beträgen nach Kategorie und nach Dienst.

  • costCentersArray<object>

    Die Ausgaben des Monats nach Kostenstelle, wie die Tag-Zuordnungsregeln des Workspace sie zuweisen.

Fehler

  • 400 Bad Request - period ist kein Monat in der Schreibweise YYYY-MM.
  • 404 Not Found - Die Quelle hat für diesen Monat keine Zahlen gespeichert, keine FOCUS-Quelle in diesem Workspace hat diese id, oder der FOCUS-Import ist für diesen Workspace nicht aktiviert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/focus-sources/{sourceId}/periods/{period}
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/{sourceId}/periods/{period}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "sourceId": "string",
   "period": "string",
   "rows": number,
   "version": "string",
   "asOf": "string",
   "totals": { "USD": number },
   "issuers": { "string": { "USD": number } },
   "invoices": [
      {
         "issuer": "string",
         "billingAccountId": "string",
         "invoiceId": "string",
         "currency": "string",
         "total": number,
         "byCategory": { "string": number },
         "byService": { "string": number },
         "corrections": number
      }
   ],
   "costCenters": [ { "costCenter": "string", "serviceCategory": "string", "currency": "string", "amount": number } ]
}

FOCUS-Upload erstellen

Startet den Upload einer FOCUS-Datei und gibt die URL zurück, an die sie zu senden ist.

POST/v1/workspaces/{regionId}/focus-sources/uploads

Body

  • fileNamestringPflicht

    Der Name der Datei, mit der Endung .csv oder .csv.gz.

Rückgabe

201 Created mit dem in der Antwort gezeigten Objekt.

Weitere Details

Startet den Upload einer FOCUS-Datei. Die Datei ist CSV oder gzip-komprimiertes CSV (.csv oder .csv.gz), bis zu 500 MB. Senden Sie sie per PUT an uploadUrl mit dem zurückgegebenen contentType und rufen Sie dann CompleteFocusUpload auf. Die URL ist ein paar Minuten gültig. Hochgeladene Dateien gehen an die Upload-Quelle des Workspace, sourceId.

Braucht 'edit'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Fehler

  • 400 Bad Request - Der Dateiname endet nicht auf .csv oder .csv.gz ("Upload a FOCUS file as CSV, or gzipped CSV (.csv.gz). Parquet files are read in a later release.").
  • 404 Not Found - Der FOCUS-Import ist für diesen Workspace nicht aktiviert ("FOCUS import isn't switched on for this workspace yet.").
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
POST /v1/workspaces/{regionId}/focus-sources/uploads
Anfrage
curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/uploads" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json
body.json
{
   "fileName": "string"
}
Antwort · 201 Created
{
   "sourceId": "string",
   "uploadId": "string",
   "uploadUrl": "string",
   "contentType": "string",
   "maxBytes": number
}

FOCUS-Upload abschließen

Teilt Pleaxy mit, dass eine hochgeladene FOCUS-Datei bereitliegt, damit sie gelesen wird.

POST/v1/workspaces/{regionId}/focus-sources/uploads/{uploadId}/complete

Parameter

  • uploadIdstringPflicht

    Die id des Uploads, wie CreateFocusUpload sie zurückgibt.

Rückgabe

202 Accepted mit dem in der Antwort gezeigten Objekt.

Weitere Details

Sagt, dass die Datei hochgeladen ist. Pleaxy liest sie im Hintergrund und gibt die Upload-Quelle zurück; ihr lastRun zeigt das Ergebnis, sobald der Lesevorgang beendet ist.

Braucht 'edit'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Antwortfelder

  • kindstring

    upload: Dateien, die Sie hochladen. aws_s3: ein FOCUS-Export von AWS Data Exports. azure_blob: ein FOCUS-Export von Azure Cost Management. gcp_bigquery: die FOCUS-Tabelle von Google Cloud. oci: die FOCUS-Berichte von Oracle Cloud. s3_compatible: ein Bucket auf einem beliebigen S3-kompatiblen Speicher.

  • periodsArray<string>

    Die Monate, für die die Quelle Zahlen gespeichert hat, als YYYY-MM.

  • lastRunobject

    Der letzte Lesevorgang: die gelesenen Monate, Dateien und Zeilen, die übersprungenen Zeilen nach Grund und failure.reason, wenn status failed ist.

  • tagKeysArray<string>

    Die häufigsten Tag-Schlüssel in den Zeilen der Quelle.

  • s3.keyHintstring

    Ein kurzer Hinweis darauf, welcher geheime Zugriffsschlüssel gespeichert ist. Das Geheimnis selbst wird nie zurückgegeben.

Fehler

  • 400 Bad Request - Die Datei ist größer als 500 MB, oder uploadId ist keine Upload-id.
  • 404 Not Found - Kein Upload mit dieser id wartet in diesem Workspace: Laden Sie die Datei erneut hoch. Auch, wenn der FOCUS-Import für diesen Workspace nicht aktiviert ist.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
POST /v1/workspaces/{regionId}/focus-sources/uploads/{uploadId}/complete
Anfrage
curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/uploads/{uploadId}/complete" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 202 Accepted
{
   "id": "string",
   "kind": "upload" | "aws_s3" | "azure_blob" | "gcp_bigquery" | "oci" | "s3_compatible",
   "label": "string",
   "provider": "aws" | "azure" | "gcp" | "oci",
   "connectionId": "string",
   "aws": { "bucket": "string", "prefix": "string", "region": "string" },
   "azure": { "storageAccount": "string", "container": "string", "directory": "string" },
   "gcp": { "table": "string" },
   "oci": { "region": "string" },
   "s3": { "endpoint": "string", "region": "string", "bucket": "string", "prefix": "string", "accessKeyId": "string", "keyHint": "string" },
   "periods": [ "string" ],
   "lastRun": {
      "runId": "string",
      "startedAt": "string",
      "finishedAt": "string",
      "status": "ok" | "partial" | "failed",
      "trigger": "schedule" | "manual" | "upload",
      "periods": [ "string" ],
      "files": number,
      "rows": number,
      "skipped": number,
      "skippedByReason": { "noBillingPeriod": number, "badNumber": number, "badCurrency": number, "badChargePeriod": number },
      "ignoredFiles": number,
      "version": "string",
      "failure": { "reason": "accessDenied" | "notFound" | "wrongRegion" | "notFocus" | "parquetUnsupported" | "connectionMissing" | "credentialRejected" | "unreachable" | "other", "detail": "string" }
   },
   "tagKeys": [ "string" ],
   "commitments": [ { "id": "string", "contractId": "string", "category": "string", "type": "string", "periodStart": "string", "periodEnd": "string", "cost": number, "currency": "string" } ],
   "createdAt": "string",
   "updatedAt": "string"
}

FOCUS-Aussteller auflisten

Listet die Rechnungsaussteller in den gespeicherten FOCUS-Monaten auf und den Lieferanten, dem jeder zugeordnet ist.

GET/v1/workspaces/{regionId}/focus-sources/issuers

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt jeden Rechnungsaussteller in den gespeicherten FOCUS-Monaten zurück (die letzten drei je Quelle), mit dem, was er je Währung berechnet hat, und dem Lieferanten, dem er zugeordnet ist, falls vorhanden.

Braucht 'view'-Zugriff auf Rechnungen.

Antwortfelder

  • issuerstring

    Der Name des Rechnungsausstellers, wie die FOCUS-Dateien ihn angeben.

  • mappedBy"person" | "name"

    person: Jemand hat den Aussteller dem Lieferanten zugeordnet. name: Pleaxy hat einen bekannten Aussteller (AWS, Microsoft, Google, Oracle) an seinem Namen erkannt. Fehlt, wenn der Aussteller keinen Lieferanten hat.

  • totalsobject

    Was der Aussteller in den gespeicherten Monaten berechnet hat, nach Währungscode.

Fehler

  • 404 Not Found - Der FOCUS-Import ist für diesen Workspace nicht aktiviert ("FOCUS import isn't switched on for this workspace yet.").
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/focus-sources/issuers
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/issuers" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
[
   {
      "issuer": "string",
      "supplierConnectionId": "string",
      "supplierName": "string",
      "mappedBy": "person" | "name",
      "totals": { "USD": number }
   }
]

FOCUS-Aussteller zuordnen

Ordnet einen FOCUS-Rechnungsaussteller einem Ihrer Lieferanten zu oder verwirft die Zuordnung.

PUT/v1/workspaces/{regionId}/focus-sources/issuers/{issuer}

Parameter

  • issuerstringPflicht

    Der Name des Ausstellers, wie die FOCUS-Dateien ihn angeben, URL-kodiert.

Body

  • supplierConnectionIdstring | null

    Die Verbindungs-id des Lieferanten. null oder Weglassen verwirft die Zuordnung.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Ordnet einen Rechnungsaussteller einem Lieferanten des Workspace zu. Gibt die Aussteller wie ListFocusIssuers zurück.

Braucht 'edit'-Zugriff auf Rechnungen. Ein API-Schlüssel kann es aufrufen.

Antwortfelder

  • issuerstring

    Der Name des Rechnungsausstellers, wie die FOCUS-Dateien ihn angeben.

  • mappedBy"person" | "name"

    person: Jemand hat den Aussteller dem Lieferanten zugeordnet. name: Pleaxy hat einen bekannten Aussteller (AWS, Microsoft, Google, Oracle) an seinem Namen erkannt. Fehlt, wenn der Aussteller keinen Lieferanten hat.

  • totalsobject

    Was der Aussteller in den gespeicherten Monaten berechnet hat, nach Währungscode.

Fehler

  • 400 Bad Request - Der Name des Ausstellers ist leer oder zu lang.
  • 404 Not Found - Kein Lieferant in diesem Workspace hat diese supplierConnectionId, oder der FOCUS-Import ist für diesen Workspace nicht aktiviert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
PUT /v1/workspaces/{regionId}/focus-sources/issuers/{issuer}
Anfrage
curl -X PUT "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-sources/issuers/{issuer}" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json
body.json
{
   "supplierConnectionId": "string" | null
}
Antwort · 200 OK
[
   {
      "issuer": "string",
      "supplierConnectionId": "string",
      "supplierName": "string",
      "mappedBy": "person" | "name",
      "totals": { "USD": number }
   }
]
Kontakt aufnehmen