VRPlatformVRPlatform
Audit

/audit/events/{id}

Work in progress: this contract is not frozen and can change without backward compatibility. Get one team-scoped public audit event with revision-bound, paginated observed journal-entry changes and safe cause attribution.

Required scope: audit:read

GET
/audit/events/{id}

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

entryCursor?string
Length1 <= length
entryLimit?integer
Default100
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://staging.api.vrplatform.app/audit/events/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "revision": 9007199254740991,
  "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
  "team": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "uniqueRef": "string",
    "name": "string"
  },
  "occurredAt": "2024-01-15T12:30:00.000+00:00",
  "updatedAt": "2024-01-15T12:30:00.000+00:00",
  "actor": {
    "type": "user",
    "id": "string",
    "name": "string",
    "email": "user@example.com",
    "label": "string"
  },
  "source": {
    "type": "portal",
    "requestId": "string"
  },
  "action": {
    "code": "string",
    "summary": "string",
    "operation": "create"
  },
  "rootEntity": {
    "type": "account",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "uniqueRef": "string",
    "name": "string"
  },
  "entityChanges": [
    {
      "entity": {
        "type": "account",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "uniqueRef": "string",
        "name": "string"
      },
      "operation": "create",
      "changes": [
        {
          "path": "string",
          "before": {
            "type": "string",
            "value": "string"
          },
          "after": {
            "type": "string",
            "value": "string"
          }
        }
      ],
      "redactedFields": [
        "string"
      ]
    }
  ],
  "accountingImpact": {
    "status": "not_applicable",
    "netEffect": [
      {
        "account": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "category": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "classification": "string"
          }
        },
        "amount": {
          "type": "money",
          "centTotal": -9007199254740991,
          "currency": "string"
        }
      }
    ]
  },
  "entryChanges": {
    "data": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "journalEntryId": "72600ee4-b304-47f3-89cd-f685d2692490",
        "operation": "insert",
        "changedAt": "2024-01-15T12:30:00.000+00:00",
        "changedFields": [
          "string"
        ],
        "before": {
          "account": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "category": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "classification": "string"
            }
          },
          "amount": {
            "type": "money",
            "centTotal": -9007199254740991,
            "currency": "string"
          },
          "postingDate": {
            "type": "date",
            "value": "string"
          },
          "ledger": {
            "type": "enum",
            "value": "string"
          },
          "status": {
            "type": "enum",
            "value": "string"
          },
          "party": {
            "type": "enum",
            "value": "string"
          },
          "ownershipPeriod": {
            "type": "entity_reference",
            "entityType": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          },
          "ownerStatement": {
            "type": "entity_reference",
            "entityType": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        },
        "after": {
          "account": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "category": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "classification": "string"
            }
          },
          "amount": {
            "type": "money",
            "centTotal": -9007199254740991,
            "currency": "string"
          },
          "postingDate": {
            "type": "date",
            "value": "string"
          },
          "ledger": {
            "type": "enum",
            "value": "string"
          },
          "status": {
            "type": "enum",
            "value": "string"
          },
          "party": {
            "type": "enum",
            "value": "string"
          },
          "ownershipPeriod": {
            "type": "entity_reference",
            "entityType": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          },
          "ownerStatement": {
            "type": "entity_reference",
            "entityType": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        },
        "causedBy": {
          "entity": {
            "type": "account",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          },
          "operation": "create",
          "changedPaths": [
            "string"
          ]
        }
      }
    ],
    "page": {
      "eventRevision": 9007199254740991,
      "limit": 9007199254740991,
      "hasMore": true,
      "nextCursor": "string"
    }
  }
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_EVENT_REVISED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "currentRevision": 9007199254740991
  }
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/audit/effects GET

Previous Page

/audit/events GET

Next Page