API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · payroll_recovery_configs

Payroll Recovery Config Schema

Schema-ID
payroll_recovery_config
Collection
payroll_recovery_configs
Permissions
  • Lesenpayroll_view
  • Anlegenpayroll_recovery
  • Ändernpayroll_recovery
  • Löschenpayroll_recovery

Felder

Payroll Recovery Config Schema

payroll_recovery_configs4 Permissions

Tenant-level payroll module configuration and recovery metadata.

activatedbooleanerforderlich

Whether the payroll module has been activated for this tenant

Default: false
activatedAtdatetimeoptional

When the activation wizard was completed

read-onlynullable
activatedByuuidoptional

User UUID of the GF/Owner who activated the module

read-onlynullable
currentKeyIdstringerforderlich

Current group key version identifier (e.g. UUID v7)

max 64 Zeichenread-only
keyRotatedAtdatetimeoptional

When the group key was last rotated

nullable
checksumPepperstringoptional

Tenant-specific HMAC pepper (32 random bytes, base64url) for shareChecksum. Generated at activation; absent for tenants activated before the pepper rollout (legacy SHA-256 path).

max 64 Zeichennullable
hrMembersobject[]optional

HR team members with access to payroll data

Default: []
userIduuiderforderlich
wrappedGroupKeystringerforderlich

Base64url-encoded payroll group key wrapped with this user ECDH public key. AES-KW of a 32-byte key produces 40 bytes → ~54 base64url chars; 128 leaves headroom but blocks DoS payloads.

max 128 Zeichen
ephemeralPublicKeystringoptional

Sender ephemeral ECDH public key used during ECDH-ES wrap

max 256 Zeichen
keyIdstringoptional

Group key version this wrapped key corresponds to

max 64 Zeichen
addedAtdatetimeerforderlich
addedByuuidoptional
nullable
removedAtdatetimeoptional

When this member was removed (kept for audit)

nullable
shamirConfigobjectoptional
nullable
nintegererforderlich

Total number of shares generated

2 – 7
thresholdintegererforderlich

Minimum number of shares required for reconstruction

2 – 7
sharesobject[]erforderlich

Per-share metadata. The actual share values are NEVER stored — only this metadata.

shareIdstringerforderlich

Share identifier (also printed on the token sheet)

max 64 Zeichen
indexintegeroptional

GF(256) x-coordinate of the Shamir share (the first byte of the raw share, also printed on the token sheet as "Index"). Required to reconstruct the share during recovery — the BIP-39 mnemonic alone only encodes the 32 secret bytes.

1 – 255
recipientLabelstringerforderlich

Free-text label of the share recipient (e.g. "Maximilian M.")

max 200 Zeichen
recipientUserIduuidoptional

Optional link to a user (if recipient is a Codemeta user)

nullable
checksumstringoptional

Short checksum for share validation during recovery

max 32 Zeichen
generatedAtdatetimeerforderlich
acknowledgedAtdatetimeoptional

When the GF confirmed the token was printed and handed over

nullable
invalidatedAtdatetimeoptional

When this share was invalidated (e.g. token rotation, member change, recovery completed)

nullable
steuerberaterobjectoptional
nullable
firmNamestringoptional
max 200 Zeichen
contactNamestringoptional
max 200 Zeichen
emailemailoptional
max 200 Zeichen
phonestringoptional
max 50 Zeichennullable
datevAdvisorNumberstringoptional

DATEV-Berater-Nummer

max 20 Zeichennullable
datevClientNumberstringoptional

DATEV-Mandanten-Nummer

max 20 Zeichennullable
recoveryHistoryobject[]optional

Audit trail of recovery events (cleartext, no secrets)

max 50 ItemsDefault: []read-only
recoveredAtdatetimeerforderlich
recoveredByuuiderforderlich
shareIdsUsedstring[]optional

Share IDs of the tokens used for reconstruction

newKeyIdstringoptional
max 64 Zeichen
reasonstringoptional
max 500 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/payroll_recovery_configs — Liste, paginiert + filterbar
  • GET /api/v1/payroll_recovery_configs/<id> — Einzelne Entity
  • POST /api/v1/payroll_recovery_configs — Anlegen
  • PATCH /api/v1/payroll_recovery_configs/<id> — Teil-Update
  • DELETE /api/v1/payroll_recovery_configs/<id> — Soft-Delete
  • GET /api/v1/payroll_recovery_configs/<id>/timeline — Audit + Aktivitäten

Suche