Basenet Public API

Versioned public REST API for the Basenet legal practice platform. Versioning policy: the /api/v1 path prefix is the major version; breaking changes ship under /api/v2 with v1 supported through a published deprecation window. Auth uses scoped Bearer tokens; every request is permission-filtered by the same engine that guards the UI. Rate limits are per token. Money is integer cents; timestamps are ISO-8601 UTC.

matters

• GET
  List matters (scope matters:read)/api/v1/matters
• POST
  Create a matter (scope matters:write)/api/v1/matters
• GET
  Get a matter (scope matters:read)/api/v1/matters/{id}
• GET
  Get legal-aid (toevoeging) details for a matter (scope billing:read). Returns present=false when no row exists./api/v1/matters/{id}/legal-aid
• PUT
  Create or update legal-aid (toevoeging) details for a matter (scope billing:write; billing update required)./api/v1/matters/{id}/legal-aid
• POST
  Add another legal-aid grant (toevoeging) to a matter; it becomes the active grant billing runs through (scope billing:write; billing update required)./api/v1/matters/{id}/legal-aid

relations

• GET
  List relations (scope relations:read)/api/v1/relations
• POST
  Create a relation (scope relations:write). Runs the advisory duplicate check; send confirmDuplicates=true to create anyway after reviewing matches (BLI-1408)./api/v1/relations
• GET
  Get a relation (scope relations:read)/api/v1/relations/{id}

documents

• GET
  List document metadata (scope documents:read)/api/v1/documents
• GET
  Export permission-filtered document metadata CSV (scope documents:read)/api/v1/documents/export
• GET
  Download document content (scope documents:read)/api/v1/documents/{id}/content

hours

• GET
  List hour entries (scope hours:read)/api/v1/hours
• POST
  Create an hour entry (scope hours:write)/api/v1/hours

tasks

• GET
  List tasks (scope tasks:read)/api/v1/tasks
• POST
  Create a task (scope tasks:write)/api/v1/tasks

webhooks

• GET
  List webhook subscriptions (scope webhooks:admin)/api/v1/webhooks
• POST
  Create a webhook subscription (scope webhooks:admin)/api/v1/webhooks

billing

• GET
  List invoices (scope billing:read)/api/v1/invoices

bi

• GET
  OData service document listing the BI entity sets (scope bi:read)/api/v1/bi
• GET
  OData v4 $metadata (EDMX) for the BI entity sets (scope bi:read)/api/v1/bi/$metadata
• GET
  BI: denormalized matters (scope bi:read)/api/v1/bi/matters
• GET
  BI: denormalized hours (scope bi:read)/api/v1/bi/hours
• GET
  BI: denormalized billing (scope bi:read)/api/v1/bi/billing

offline-sync

• GET
  List devices for the calling staff API token user (scope sync:read)/api/v1/sync/devices
• POST
  Register a device and return its device bearer token once (scope sync:write)/api/v1/sync/devices
• DELETE
  Revoke one of the calling user’s devices (scope sync:write)/api/v1/sync/devices/{id}
• GET
  Bootstrap an offline-sync device session (device bearer token)/api/v1/sync/bootstrap
• POST
  Enable or disable a matter subscription for the authenticated device/api/v1/sync/subscriptions
• POST
  Compute the server-owned sync plan for a matter/api/v1/sync/matters/{id}/reconcile
• GET
  Download document bytes for a sync plan download action/api/v1/sync/documents/{id}/content
• POST
  Upload bytes for a new document or document version/api/v1/sync/matters/{id}/documents
• POST
  Commit the post-transfer baseline for a matter/api/v1/sync/matters/{id}/commit
• GET
  Advertise the currently selected offline-sync contract version/api/v1/sync/contract-version

proposals

• POST
  Create an agent proposal without mutating business data (scope proposals:write)/api/v1/proposals
• GET
  Get a permission-filtered proposal (scope proposals:read)/api/v1/proposals/{id}
• DELETE
  Cancel an open or accepted proposal (scope proposals:write)/api/v1/proposals/{id}
• PATCH
  Revise an open proposal and increment its version (scope proposals:write)/api/v1/proposals/{id}
• POST
  Accept an exact proposal version (interactive human sessions only)/api/v1/proposals/{id}/accept
• POST
  Commit an accepted, allowlisted proposal idempotently (scope proposals:write)/api/v1/proposals/{id}/commit