All about 'Case Data'

Employee Data incl. Documents

Employee-level Case Changes - entry, salary, personal details - reported the same way as any other case change (see New CaseChanges). Some employee case fields don't hold a text or number value - they hold a file. A signed contract, a scanned ID, a salary certificate: these are reported the same way as any other case change, just with a documents array attached to the value instead of (or alongside) a value.

This is different from Outputs: outputs are files Ason generates (payslips, declarations). Documents are files you upload as evidence for a case value.

Employee Case Fields

Reference list of all case fields used to report an Employee Case Change - the same fields used in the "Enter salary & employee data" step of the Quickstart. See New CaseChanges for how to report them.

Employee Master Data - Period fields, valid from a start date onward until changed again (e.g. address, bank details).

Full reference (100+ fields) available via the API Reference - the table above shows the most commonly used fields.

Variable data for employees - Moment fields, tied to a single point in time, e.g. hours worked or a one-off bonus.

Full reference (100+ fields) available via the API Reference - the table above shows the most commonly used fields.

Attaching a document

Add a documents array to any CaseValueSetup in a case change, and include employeeId (instead of relying on divisionId alone) so the value is scoped to the right employee. Each document entry needs a name, a contentType (MIME type), and base64-encoded content.

The response echoes back each value with its own id - that id is the case value id, and it's what you need to retrieve or delete the document later. It is not the same as the case change id.

Retrieving documents

_

List documents on an employee case value

Supports the usual OData query parameters (filter, select, top, skip, ...). Each item in the list is a reference (id, name, contentType) - append /{documentId} to fetch the actual content.

Deleting a document

DELETE the same single-document URL (.../documents/{documentId}) to remove it. This is permanent - there's no separate archive step.

▶ Frontend video

FAQ

How does this differ from what Quickstart step 6 does?

It's the same mechanism - Quickstart step 6 is a live example of exactly this.

Can I attach more than one document to a case value?

Yes - the documents array accepts multiple entries.

How do I find the caseValueId for a document I attached earlier?

It's returned in the response when you report the case change - see "Attaching a document" above.

Can employees see their own documents?

Yes, via ESS.

Is this only the data of the individual employee?

Yes - everything here is scoped to employeeId.

Does everything else work the same as on the company side?

Yes - same mechanism as Company Data incl. Documents: today's values by default, full history per field, documents attached to case values, deletable only via the API.

Employee events (Ereignisse)

The employee's own case-change history - same idea as company events, just scoped to that employee: event/field/value with Start/End/Created and reason, no "changed by" attribution.

API Endpoints

What	Call
Report an employee case change	POST /tenants/{orgId}/payrolls/{payrollId}/cases/sets
List case fields that hold documents	GET /tenants/{orgId}/payrolls/{payrollId}/casefields
Get an employee document	GET /tenants/{orgId}/employees/{employeeId}/cases/{caseValueId}/documents/{documentId}
Delete a document	DELETE (same URL as above)