Skip to main content

Cospend integration

Costs
cospend
Provider stub

Link NC Cospend projects and bills to Open Register objects. Detail-page widget shows a Total Spent summary. Provider stub today.

Group
Workflow
Required app
cospend
Storage
Link table
Icon
CurrencyEur

Track project costs against an Open Register object. The Costs tab will surface linked Cospend projects and individual bills with amount, currency, and split. The detail-page widget shows a total-spent summary. Provider registers today; the wrapping service + link table land in a follow-up.

Screenshot​

The integration registers in OpenRegister's in-page registry and renders as one of the tabs on the standalone integrations view. The tab is highlighted active here so you can see exactly which surface this leaf controls.

cospend integration tab active in the OpenRegister integrations view

Captured by tests/e2e/leaf-screenshots.spec.ts against the seeded integration-verification register on the dev container. Empty state (Nothing linked yet) is expected on a freshly seeded object — link an upstream entity from the tab's + Add affordance to populate it.

What it will do​

  • Lists Cospend projects and bills linked to each Open Register object on the Costs sidebar tab.
  • Shows total, currency, payer, and split per row.
  • Renders a "Total spent" summary on the detail-page widget.
  • Lets users link or unlink. The Cospend project/bill stays in NC Cospend.

Setup​

1. Install NC Cospend​

Install the cospend Nextcloud app. The Costs tab appears once it's enabled.

2. Use it on an object​

Open any object whose schema declares linkedTypes: ['cospend']. The Costs tab appears. Today it renders the empty state until the wrapping service lands.

Configuration​

FieldOpen Register sideNC Cospend side
Storagelink-table (openregister_cospend_links, pending)NC Cospend project + bill stores
RefreshPer render—
AuthNone (uses session)Cospend's user ACL

Local verification setup​

The leaf-verification harness in tests/e2e/leaf-verification.spec.ts probes every advertised provider against the seeded integration-verification register; you can reproduce a single-leaf check by hand against any OpenRegister dev container.

1. Install the cospend Nextcloud app​

docker exec -u www-data nextcloud php occ app:install cospend
docker exec -u www-data nextcloud php occ app:enable cospend
docker exec nextcloud apache2ctl graceful   # bust OPcache so the registry sees the new app

Without cospend enabled, the cospend provider reports enabled: false on the OCS capabilities payload and its sub-resource endpoint refuses to dispatch.

2. Probe the registry to confirm the provider is advertised​

curl -s -u admin:admin -H 'OCS-APIRequest: true' \
  http://localhost:8080/ocs/v2.php/cloud/capabilities?format=json \
  | jq '.ocs.data.capabilities.openregister.integrations.providers[] | select(.id == "cospend")'

Expected payload — the enabled flag flips to true once the required app is installed.

3. Probe the per-object sub-resource​

curl -s -u admin:admin -H 'OCS-APIRequest: true' \
  "http://localhost:8080/index.php/apps/openregister/api/objects/21/166/25706ca9-c989-4d6b-9f7b-98cf1cc70639/integrations/cospend"

Most recent harness run (against the seeded verification-probe object on this dev container):

  • Status: 200 (list-envelope)
  • Latency: 87ms
  • Body: matches the documented list envelope below
{
  "items": []
}

The OCS-APIRequest: true header is mandatory — without it, Nextcloud's session-CSRF guard short-circuits with HTTP 412 before the provider runs. An empty items: [] is the correct response for a freshly-seeded object that hasn't been linked to any upstream cospend entity yet.

Current status​

Provider registered. Wrapping service + link table tracked under openspec/changes/integration-cospend.