Company

Create a company

POST /{instanceName}/api/v1/{locale}/company

Creates a company and returns the full entity. 201 with a Location header.

Forespørselskropp

application/json → CompanyCreateDto

Svar

Eksempel

curl -X POST "https://api.visena.example/acme/api/v1/en/company" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Logistics AS",
    "countryCode": "NO",
    "ownerGroupId": "gH8dF3",
    "organizationalNumbers": [
      {
        "orgNumber": "923609016",
        "countryCode": "NO"
      }
    ]
  }'

Get a company

GET /{instanceName}/api/v1/{locale}/company/{companyId}

Returns the full entity. 404 if unknown; 400 if the id cannot be unmasked.

Parametere

Svar

Eksempel

curl "https://api.visena.example/acme/api/v1/en/company/bQ4wR8" \
  -H "Authorization: Bearer $TOKEN"

List companies (offset-paginated)

GET /{instanceName}/api/v1/{locale}/company

Offset/limit paging with a real total. Optional filters: query (name search), isActive, ownerGroupId, orgNumber (exact active org number), companyNumber (exact), externalReference (exact); and a created/modified/name sort. RFC 8288 navigation links are in the body. view selects the item projection: set view=full to receive, for every row, the same body the per-company read returns (createdBy/modifiedBy and the AML triad included) instead of the lean list item; allowed values are lean and full, the default is lean, and view=full caps limit at 100.

Parametere

Svar

Eksempel

curl "https://api.visena.example/acme/api/v1/en/company?offset=0&limit=20" \
  -H "Authorization: Bearer $TOKEN"

List companies (cursor-paginated, insert-stable)

GET /{instanceName}/api/v1/{locale}/company/cursor

Keyset paging over the monotonic entity id (insertion order). Pass the opaque cursor from a previous page's nextCursor/prevCursor; omit it for the first page. No total — keyset skips the count. Same filters as the offset list: query, isActive, ownerGroupId, orgNumber, companyNumber, externalReference. view selects the item projection: set view=full to receive, for every row, the same body the per-company read returns (createdBy/modifiedBy and the AML triad included) instead of the lean list item; allowed values are lean and full, the default is lean, and view=full caps limit at 100.

Listene med offset, cursor og timeline er tre ulike lesemoduser. Hvilken du bruker til et engangsuttrekk og hvilken du gjenopptar en løpende synkronisering fra, hvordan du dedupliserer det du mottar, og hva et listesvar ikke forteller deg om slettinger, er dokumentert én gang for hele API-et under Lister, paginering og synk. Les den før du bygger en synkronisering på noen av dem.

Parametere

Svar

Eksempel

curl "https://api.visena.example/acme/api/v1/en/company/cursor?limit=100" \
  -H "Authorization: Bearer $TOKEN"

List companies (time-windowed, cursor-paginated)

GET /{instanceName}/api/v1/{locale}/company/timeline

Keyset paging from an optional since lower bound on a selectable key (created|modified). RFC 9557 Z timestamps. A cursor minted for a different key is rejected with 400. view selects the item projection: set view=full to receive, for every row, the same body the per-company read returns (createdBy/modifiedBy and the AML triad included) instead of the lean list item; allowed values are lean and full, the default is lean, and view=full caps limit at 100.

Parametere

Svar

Eksempel

curl "https://api.visena.example/acme/api/v1/en/company/timeline?since=2026-08-20T02:00:00Z" \
  -H "Authorization: Bearer $TOKEN"

Search for potential duplicate companies

GET /{instanceName}/api/v1/{locale}/company/duplicates

Duplicate-detection probe for the create flow. Matches by exact organizational number (active numbers only) and/or exact companyNumber — the same identifiers the create/update 409 guard checks, so a hit here predicts that conflict and shows the holding company when the caller is allowed to see it. At least one of orgNumber or companyNumber is required. Org-number matches are listed first; results are capped by limit (default 20; values above 100 are clamped to 100).

Parametere

Svar

Eksempel

curl "https://api.visena.example/acme/api/v1/en/company/duplicates?orgNumber=923609016" \
  -H "Authorization: Bearer $TOKEN"

Replace a company

PUT /{instanceName}/api/v1/{locale}/company/{companyId}

Full replace (PUT): omitted optional fields are cleared.

Parametere

Forespørselskropp

application/json → CompanyUpdateDto

Svar

Eksempel

curl -X PUT "https://api.visena.example/acme/api/v1/en/company/bQ4wR8" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Logistics AS",
    "countryCode": "NO",
    "ownerGroupId": "gH8dF3",
    "organizationalNumbers": [
      {
        "orgNumber": "923609016",
        "countryCode": "NO"
      }
    ]
  }'

Partially update a company (RFC 7396 JSON Merge Patch)

PATCH /{instanceName}/api/v1/{locale}/company/{companyId}

Absent fields are unchanged, JSON null clears, a value sets. An empty body {} is a no-op. Wrong content type → 415.

Parametere

Forespørselskropp

application/merge-patch+json → object

Svar

Eksempel

curl -X PATCH "https://api.visena.example/acme/api/v1/en/company/bQ4wR8" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
    "externalReference": "ERP-4711",
    "riskValue": "LOW"
  }'

Delete or deactivate a company

DELETE /{instanceName}/api/v1/{locale}/company/{companyId}

mode=deactivate (default) sets the company inactive; mode=delete hard-deletes it. 204 on success; a repeat hard-delete → 404.

Parametere

Svar

Eksempel

curl -X DELETE "https://api.visena.example/acme/api/v1/en/company/bQ4wR8?mode=deactivate" \
  -H "Authorization: Bearer $TOKEN"